SMF SSI.php Functions

Current Version: 2.0 RC3

This file is used to demonstrate the capabilities of SSI.php using PHP include functions. The examples show the include tag, then the results of it.

Include Code

To use SSI.php in your page add at the very top of your page before the <html> tag on line 1 of your php file:

Code: [Select]
<?php require("SSI.php"); ?>

Some notes on usage

All the functions have an output method parameter. This can either be "echo" (the default) or "array"

If it is "echo", the function will act normally - otherwise, it will return an array containing information about the requested task. For example, it might return a list of topics for ssi_recentTopics.

This functionality can be used to allow you to present the information in any way you wish.

Additional Guides & FAQ

Need more information on using SSI.php? Check out Using SSI.php article or the SSI FAQ.

Recent Topics Function

Code (simple mode)

Code: [Select]
<?php ssi_recentTopics(); ?>

Code (advanced mode)

Code: [Select]
<?php ssi_recentTopics($num_recent = 8, $exclude_boards = null, $include_boards = null, $output_method = 'echo'); ?>

Result

Recent Poll Function

Code

Code: [Select]
<?php ssi_recentPoll(); ?>

Result

Top Boards Function

Shows top boards by the number of posts.

Code

Code: [Select]
<?php ssi_topBoards(); ?>

Result

Board Topics Posts
Suggestions and Bugs New 1131 1160
Downloads 0 1022
General Help New 548 579
Screenshots New 312 334
News and Announcements New 5 7
Starship FAQ 0 0

Top Poll Function

Shows the most-voted-in poll.

Code

Code: [Select]
<?php ssi_topPoll(); ?>

Result

Top Poster Function

Shows the top poster's name and profile link.

Code

Code: [Select]
<?php ssi_topPoster(); ?>

Result

Latest Member Function

Shows the latest member's name and profile link.

Code

Code: [Select]
<?php ssi_latestMember(); ?>

Result

Please welcome chenxij201, our newest member.

Member of the Day

Shows one random member of the day. This changes once a day.

Code

Code: [Select]
<?php ssi_randomMember('day'); ?>

Result

Who's Online Function

This function shows who are online inside the forum.

Code

Code: [Select]
<?php ssi_whosOnline(); ?>

Result

1 Guest, 0 Users

Log Online Presence

This function logs the SSI page's visitor, then shows the Who's Online list. In other words, this function shows who are online inside and outside the forum.

Code

Code: [Select]
<?php ssi_logOnline(); ?>

Result

1 Guest, 0 Users

Login Function

Shows a login box only when user is not logged in.

Code

Code: [Select]
<?php ssi_login(); ?>

Result

 
 

Logout Function

Shows a logout link only when user is logged in.

Code

Code: [Select]
<?php ssi_logout(); ?>

Result

Welcome Function

Greets users or guests, also shows user's messages if logged in.

Code

Code: [Select]
<?php ssi_welcome(); ?>

Result

Welcome, Guest. Please login or register.

Today's Calendar Function

Code

Code: [Select]
<?php ssi_todaysCalendar(); ?>

Result

Memorial Day

Today's Birthdays Function

Code

Code: [Select]
<?php ssi_todaysBirthdays(); ?>

Result

Today's Holidays Function

Code

Code: [Select]
<?php ssi_todaysHolidays(); ?>

Result

Memorial Day

Today's Events Function

Code

Code: [Select]
<?php ssi_todaysEvents(); ?>

Result

Recent Calendar Events Function

Code

Code: [Select]
<?php ssi_recentEvents(); ?>

Result

Forum Stats

Shows some basic forum stats: total members, posts, topics, boards, etc.

Code

Code: [Select]
<?php ssi_boardStats(); ?>

Result

Total Members: 319
Total Posts: 2080
Total Topics: 1996
Total Categories: 2
Total Boards: 6

News Function

Shows random forum news.

Code

Code: [Select]
<?php ssi_news(); ?>

Result

AP forum now open for business!

Board News Function

Shows the latest posts from read only boards, or a specific board.

Code

Code: [Select]
<?php ssi_boardNews(); ?>

Result

xx Your chance to own a piece of history, if you have the $$$$$$$

July 30, 2010, 06:14:42 pm by John J. Thuot II
This is not mine, not associated to it any way, but Radio Flyers LLC Starship is for sale.  A friend of mine Tyler (AKA American) on the Flightsim.com forum sent this piece of news my way - check it out.....

Anyone have $1,650,000 USD? :o

http://www.controller.com/listingsdetail/aircraft-for-sale/BEECHCRAFT-STARSHIP-2000A/1992-BEECHCRAFT-STARSHIP-2000A/1173478.htm

Thanks for that info Tyler, really cool piece of news! :)

1 comment | Write Comment

xx Forum look and features

July 09, 2010, 03:24:50 pm by Asad
Hey guys,

Friendly neighbourhood admin Asad here. I'm making changes to the forum's look and feel, to align it more with our main site.

If you'd like to comment on the changes or report any problems, this is the place to do it.

Cheers!
1 comment | Write Comment

thumbup Author of Starship Diaries, Dallas Kachan wrote me regarding our Project!

July 01, 2010, 02:08:02 pm by John J. Thuot II
Hello all!

A while ago when we started this project, I wrote Dallas Kachan of "The Starship Diaries" for permission to be able to compile the flight plans listed in his novel for our project.  Of course, one of the liveries as well had to match the Starship in the novel for use with those flight plans, 401AS. 

Mr. Kachan wrote me last night saying how thrilled he was when he saw that we immortalized his N401AS as in the Starship Diaries, and can't wait to fly the finished product as well. 

I of course have been proud of our project from the very beginning, but it's times like this that really make me thrilled to see that all our hard work is being noticed!

If you are registered for Flightsim.com, another Flightsim Site that I visit frequently, you can download a PREVIEW of his book in this download package: http://www.flightsim.com/kdl.php?fid=75530 note you must register for a free account before downloading there....

If you haven't read the Starship Diaries, the site for the book is below:
http://www.starshipdiaries.com

It is a fantastically written novel, and anyone who is a Starship fan will surely enjoy it. It's wonderfully written about the adventures and travels he participates in flying Starship N401AS, and any aviation as well as non-aviation enthusiast will really enjoy it.


Again, great job on everyone's part, and I look forward to seeing this project released, as I'm sure everyone else does.

Go Team!
0 comments | Write Comment

xx Model is complete - Avionics, Sound, and Flight Dynamics Remaining

June 21, 2010, 06:21:58 pm by John J. Thuot II
Hey all!

I'm pleased to announce our modeling stage is complete.  We have taken delivery of our model and John Evans is starting the master mind work shortly of animating, dropping in avionics, and building accurate Flight Dynamics for her.

We DON'T think you'll be disappointed with the outcome.

I'd like to thank everyone in the community for showing interest in our project, and we're sure with your help it will be a huge success!

0 comments | Write Comment

smiley Welcome!

June 19, 2010, 09:15:25 pm by jevans
Welcome to the Archangel Productions Support Forum!

Here you can find answers to all your questions and problems with any of our products. Please feel free to also submit suggestions or bug reports in the appropriate forums.

Please keep discussion on topic and limited to Archangel Productions: these are not general discussion forums, as there are plenty of excellent general simulation websites around like Flightsim.com and AVSIM for general discussion.

Other than that, please enjoy! :D
0 comments

Menubar Function

Displays a menu bar, like one displayed at the top of the forum.

Code

Code: [Select]
<?php ssi_menubar(); ?>

Result

Quick Search Function

Code

Code: [Select]
<?php ssi_quickSearch(); ?>

Result

Recent Attachments Function

Code

Code: [Select]
<?php ssi_recentAttachments(); ?>

Result

Show Single Poll

Shows a poll in the specified topic.

Code

Code: [Select]
<?php ssi_showPoll($topicID); ?>

Result

Not shown because it needs specific topic ID that contains a poll.

Show Single Post

Fetches a post with a particular IDs. By default will only show if you have permission to the see the board in question. This can be overriden by passing the 2nd parameter as true.

Code

Code: [Select]
<?php ssi_fetchPosts($postIDs, $isOverride); ?>

Result

Not shown because it needs a specific post ID.

Show Single Member

Shows the specified member's name and profile link.

Code

Code: [Select]
<?php ssi_fetchMember($memberIDs); ?>

Result

Not shown because it needs a specific member ID.

Show Group Members

Shows all members in a specified group.

Code

Code: [Select]
<?php ssi_fetchGroupMembers($groupIDs); ?>

Result

Not shown because it needs specific membergroup IDs.

Home Page Sample

This sample uses the following features: ssi_recentTopics(), ssi_logOnline(), ssi_welcome(), and ssi_boardNews(). ssi_recentTopics() is fetched using the array method, to allow further customizations on the output.

Code

Code: [Select]
<?php require("SSI.php"); ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>SSI.php example for home page</title> <style type="text/css"> body { font-family: Arial, Tahoma, sans-serif; font-size: 80%; background: #DFDFDF; color: #FFFFFF; margin: 0 } ul,ol { padding-left: 19px; margin: 0; } li { font-size: 11px; } h1,h2,h3 { margin: 0; padding: 0; } h3 { font-size: 15px; } a:link,a:visited { color: #FF9000; text-decoration: none; } a:hover { text-decoration: underline; } #container { background: #52514E; width: 100%; border: 1px solid midnightblue; line-height: 150%; margin: 0; } #header,#footer { color: lightgray; background-color: #2A2825; clear: both; padding: .5em; } #leftbar { background: #DF7E00; float: left; width: 160px; margin: 0; padding: 1em; } #leftbar a { color: #000000; text-decoration: underline; } #content { margin-left: 190px; padding: 1em; } #navigation { float: right; } #navigation a:link,#navigation a:visited { color: #FF9000; } </style> </head> <body> <div id="container"> <div id="header"> <div id="navigation"> <a href="#">Link</a> | <a href="#">Link</a> | <a href="#">Link</a> | <a href="#">Link</a> | <a href="#">Link</a> </div> <h1 class="header">YourWebsite.com</h1> </div> <div id="leftbar"> <h3>Recent Forum Topics</h3> <ul> <?php // Using array method to show shorter display style. $topics = ssi_recentTopics(8, null, null, 'array'); foreach ($topics as $topic) { // Uncomment the following code to get a listing of array elements that SMF provides for this function. // echo '<pre>', print_r($topic), '</pre>'; echo ' <li><a href=\"', $topic['href'], '\">', $topic['subject'], '</a> ', $txt['by'], ' ', $topics[$i]['poster']['link'], '</li>'; } unset($topics); ?> </ul><br /> <h3>Online Users</h3> <?php ssi_logOnline(); ?> </div> <div id="content"> <?php ssi_welcome(); ?><br /><br /> <h2>News</h2> <?php ssi_boardNews(); ?> </div> <div id="footer"> <a target="_blank" rel="license" href="http://creativecommons.org/licenses/publicdomain/"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/publicdomain/88x31.png" /></a> This sample website layout is dedicated to the <a target="_blank" rel="license" href="http://creativecommons.org/licenses/publicdomain/">Public Domain</a>. </div> </div> </body> </html>

Result