SSI.php Functions

Current Version: 1.1

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:

<?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 ask on the forum.

Recent Topics Function

Code (simple mode)

<?php ssi_recentTopics();

Code (advanced mode)

<?php ssi_recentTopics($num_recent = 8, $exclude_boards = null, $include_boards = null, $output_method = 'echo');

Result

Recent Poll Function

Code

<?php ssi_recentPoll();

Result

Top Poll Function

Shows the most-voted-in poll.

Code

<?php ssi_topPoll();

Result

Top Poster Function

Shows the top poster's name and profile link.

Code

<?php ssi_topPoster();

Result

Latest Member Function

Shows the latest member's name and profile link.

Code

<?php ssi_latestMember();

Result

Diamo il benvenuto a tatyf83@gmail.com, il membro più recente.

Member of the Day

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

Code

<?php ssi_randomMember('day');

Result

Who's Online Function

This function shows who are online inside the forum.

Code

<?php ssi_whosOnline();

Result

8 Visitatori, 0 Utenti

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

<?php ssi_logOnline();

Result

9 Visitatori, 0 Utenti

Login Function

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

Code

<?php ssi_login();

Result

Logout Function

Shows a logout link only when user is logged in.

Code

<?php ssi_logout();

Result

Welcome Function

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

Code

<?php ssi_welcome();

Result

Benvenuto su Progetto Registro Sostegno. Puoi effettuare il login oppure registrarti.

Today's Calendar Function

Code

<?php ssi_todaysCalendar();

Result

Today's Birthdays Function

Code

<?php ssi_todaysBirthdays();

Result

Today's Holidays Function

Code

<?php ssi_todaysHolidays();

Result

Today's Events Function

Code

<?php ssi_todaysEvents();

Result

Recent Calendar Events Function

Code

<?php ssi_recentEvents();

Result

Forum Stats

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

Code

<?php ssi_boardStats();

Result

Utenti in totale: 1.856
Post totali: 872
Topic in totale: 666
Categorie in totale: 3
Sezioni totali: 26

News Function

Shows random forum news.

Code

<?php ssi_news();

Result

Registrati per partecipare e ricevere notifiche sugli aggiornamenti.

Board News Function

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

Code

<?php ssi_boardNews();

Result

xx Registro Sostegno RSB vers. 3.2

08 Luglio 2018, 11:52 da Basile
Versione 3.2 del Registro Sostegno RSB [1]
per sottoporlo al collegio docenti per eventuale adozione nella propria scuola

Versione registro di sostegno: mod RSB vers. 3.2
0 commenti | Scrivi commento

Menubar Function

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

Code

<?php ssi_menubar();

Result

Quick Search Function

Code

<?php ssi_quickSearch();

Result

Show Single Poll

Shows a poll in the specified topic.

Code

<?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

<?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

<?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

<?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

<?php require("SSI.php"); ?>
<!DOCTYPE html>
<html>
<head>
	<title>SSI.php example for home page</title>
	<style>
		html {
			width: 99%;
		}
		body {
			font: 87.5%/150% "Segoe UI", -apple-system, BlinkMacSystemFont, "Roboto", "Oxygen", "Ubuntu", "Cantarell", "Droid Sans", "Helvetica Neue", "Trebuchet MS", Arial, sans-serif;
			background: #DFDFDF;
			color: #FFFFFF;
			margin: 0;
		}
		ul, ol {
			padding-left: 1.25em;
			margin: 0;
		}
		li {
			font-size: 1em;
		}
		h1, h2, h3 {
			margin: 0;
			padding: 0;
		}
		h3 {
			font-size: 1em;
		}
		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: #2A2825;
			clear: both;
			padding: .5em;
		}
		#leftbar {
			background: #DF7E00;
			float: left;
			width: 160px;
			margin: 0;
			padding: 1em;
		}
		#leftbar a {
			color: #000;
			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 the system 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: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