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

[General Poker Talk] 'LOL' Of The Day by Dan F August 22, 2010, 12:49:59 AM
[General Poker Talk] State of Origin by Dan F August 21, 2010, 11:07:51 PM
[General Poker Talk] Best Tournament by brookehs August 19, 2010, 07:31:50 PM
[General Poker Talk] 2010 Rookie of the year award by Skinny_Dynamite August 19, 2010, 11:11:09 AM
[Read This First] Introductions - Meet your fellow players by Skinny_Dynamite August 18, 2010, 10:08:05 AM
[Tournament Talk] Vote: Top 10 LIVE Tournament Players in New Zealand by brookehs August 16, 2010, 10:54:28 PM
[General Poker Talk] Bluff of the Year 2010 by AA1OF110 August 16, 2010, 06:00:42 PM
[General Poker Talk] 2010 PokerNZ.com Player of the year. by Dan F August 16, 2010, 05:37:26 PM

Recent Posts Function

Code

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

Result

[General Poker Talk] 'LOL' Of The Day by Dan F August 22, 2010, 12:49:59 AM
[General Poker Talk] Re: State of Origin by Dan F August 21, 2010, 11:07:51 PM
[General Poker Talk] Re: State of Origin by AA1OF110 August 21, 2010, 10:48:55 PM
[General Poker Talk] Re: State of Origin by AA1OF110 August 21, 2010, 10:41:47 PM
[General Poker Talk] Re: State of Origin by SimonW August 21, 2010, 07:30:28 PM
[General Poker Talk] Re: State of Origin by SimonW August 21, 2010, 07:18:18 PM
[General Poker Talk] Re: State of Origin by Dan F August 21, 2010, 05:42:51 PM
[General Poker Talk] Re: State of Origin by ColeS August 21, 2010, 03:58:49 PM

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
General Poker Talk New 14 64
Tournament Talk New 3 10
Read This First New 3 7
Poker Strategy 0 0
North Island Poker 0 0
South Island Poker 0 0
Jackpot Poker 0 0
Kiwi Poker League 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

brookehs

Latest Member Function

Shows the latest member's name and profile link.

Code

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

Result

Please welcome jacob_bu, 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

SixGunStar
Fish

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

Valentine's Day

Today's Birthdays Function

Code

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

Result

Today's Holidays Function

Code

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

Result

Valentine's 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: 28
Total Posts: 81
Total Topics: 20
Total Categories: 3
Total Boards: 8

News Function

Shows random forum news.

Code

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

Result

Get the latest NZ poker news at www.PokerNZ.com

Board News Function

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

Code

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

Result

xx Some basic rules - break 'em and you're goooooone!

August 02, 2010, 10:37:32 PM by Adam
No one has time to read a bunch of boring rules, so let's keep it really simple.

Don't be a dick and you'll be sweet.  ;)

This means:

Keep the flame wars to a minimum. Take your personal rants to a Facebook chat or MSN, we don't need to see it.

NO AFFILIATE LINKS - We need to pay the bills too. If you wish to advertise, please contact me adam [at] pokernz.com

All the basic rules of society count here too, no racism etc. If you wouldn't say it to your mother, don't say it here :)
0 comments

xx SITE UPDATES

August 02, 2010, 10:27:54 PM by Adam
I'll try and keep an accurate and up to date account of what's going on with the site in here.

Today we installed this new forum. Sorry, but all the old posts are goneburger.

I'm not 100% with this felt look, but we'll keep tweaking over the next few days to call it our own.

Apart from that, there are plenty of new articles on the site and from next week we've got some guest contributors kicking in to bring the site alive!

Thanks for stopping by  ;)
1 comment | Write Comment

xx Introductions - Meet your fellow players

August 02, 2010, 10:25:27 PM by Adam
Hi all, please use this thread to introduce yourself.

I'll kick off, I'm Adam and one half of the team here at PokerNZ.com.

I'm not a huge poker player, I'm more of a 'behind-the-scenes' guy and have a real passion for online poker marketing.

I've been to a number of tourneys on the rails, never played in one or cashed big online.

If there are any site issues, please fire me a message and I'll try to sort for you.

Please go ahead and introduce yourself here....
3 comments | Write Comment

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