Docs For Class Sessions

Class Overview

Located in /blogs/inc/MODEL/sessions/_sessions.class.php [line 40]

Widget
   |
   --Sessions

Author(s):

Information Tags:

Todo:

Move to a "who's online" plugin, maybe...

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties	Inherited Methods	Inherited Constants
Inherited From Widget Widget::$global_icons Widget::$title	Inherited From Widget Widget::gen_global_icons() Generate img tags for registered icons, through global_icon(). Widget::global_icon() Registers a global action icon Widget::replace_callback() Callback function used to replace only necessary values in template. Widget::replace_callback_wrapper() This is an additional wrapper to replace_vars() that allows to react on the return value of it. Widget::replace_vars() Replaces $vars$ with appropriate values.

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From Widget

Widget::$global_icons

Widget::$title

Inherited From Widget

Widget::gen_global_icons()

Generate img tags for registered icons, through global_icon().

Widget::global_icon()

Registers a global action icon

Widget::replace_callback()

Callback function used to replace only necessary values in template.

Widget::replace_callback_wrapper()

This is an additional wrapper to replace_vars() that allows to react on the return value of it.

Widget::replace_vars()

Replaces $vars$ with appropriate values.

[ Top ]

Property Summary

mixed	$_count_guests	Number of guests (and users that want to be anonymous)
mixed	$_initialized
mixed	$_registered_Users	List of registered users.

[ Top ]

Method Summary

void	display_onliners()	Template function: Display onliners, both registered users and guests.
string	display_online_guests()	Template function: Display number of online guests.
array	display_online_users()	Template function: Display the registered users who are online
array	init()	Get an array of registered users and guests.
void	number_of_guests()	Get the number of guests.
string	replace_callback()	Widget callback for template vars.

[ Top ]

Properties

mixed $_count_guests [line 49]

Number of guests (and users that want to be anonymous)

Gets lazy-filled when needed, through init().

API Tags:

Access:

protected

[ Top ]

mixed $_initialized = false [line 62]

[ Top ]

mixed $_registered_Users [line 59]

List of registered users.

Gets lazy-filled when needed, through init().

API Tags:

Access:

protected

[ Top ]

Methods

display_onliners [line 209]

void display_onliners(
)

Template function: Display onliners, both registered users and guests.

Information Tags:

Todo:

get class="" out of here (put it into skins)

[ Top ]

display_online_guests [line 183]

string display_online_guests(
[
$before = ''], [
$after = ''] 
)

Template function: Display number of online guests.

Parameters:

	$before:
	$after:

[ Top ]

display_online_users [line 143]

array display_online_users(
[string
$beforeAll = '<ul class="onlineUsers">'], [string
$afterAll = '</ul>'], [string
$templateEach = '<li class="onlineUser">$user_preferredname$ $user_msgformlink$</li>'] 
)

Template function: Display the registered users who are online

Parameters:

string	$beforeAll:	To be displayed before all users
string	$afterAll:	To be displayed after all users
string	$templateEach:	Template to display for each user, see replace_callback()

API Tags:

Return:

containing number of registered users and guests

Information Tags:

Todo:

get class="" out of here (put it into skins)

[ Top ]

init [line 70]

array init(
)

Get an array of registered users and guests.

API Tags:

Return:

containing number of registered users and guests ('registered' and 'guests')

[ Top ]

number_of_guests [line 117]

void number_of_guests(
[boolean
$display = true] 
)

Get the number of guests.

Parameters:

boolean

$display:

display?

[ Top ]

replace_callback [line 229]

string replace_callback(
array
$matches, [User
$User = NULL] 
)

Widget callback for template vars.

This replaces user properties if set through $user_xxx$ and especially $user_msgformlink$.

This allows to replace template vars, see Widget::replace_callback().

Parameters:

array	$matches:
User	$User:	an optional User object

Redefinition of:

Widget::replace_callback(): Callback function used to replace only necessary values in template.

[ Top ]

Multilingual multiuser multiblog engine

Class: Sessions

Class Sessions

Packages

Classes

Files