XoopsOnlineHandler Class Reference

Public Member Functions
	destroy ($uid)
	gc ($expire)
	getAll ($criteria=null)
	getCount ($criteria=null)
	write ($uid, $uname, $time, $module, $ip)
	XoopsOnlineHandler (&$db)

Public Attributes
	$db

Detailed Description

Definition at line 29 of file online.php.

Member Function Documentation

XoopsOnlineHandler::destroy

(

$uid

)

Delete online information for a user

Parameters

int

$uid

UID

Returns

bool TRUE on success

Definition at line 90 of file online.php.

References $result, $sql, and $uid.

XoopsOnlineHandler::gc

(

$expire

)

Garbage Collection

Delete all online information that has not been updated for a certain time

Parameters

int

$expire

Expiration time in seconds

Definition at line 106 of file online.php.

References $sql.

XoopsOnlineHandler::getAll

(

$criteria = null

)

Get an array of online information

Parameters

object

$criteria

CriteriaElement

Returns

array Array of associative arrays of online information

Definition at line 118 of file online.php.

References $criteria, $limit, $result, $ret, $sql, and $start.

XoopsOnlineHandler::getCount

(

$criteria = null

)

Count the number of online users

Parameters

object

$criteria

CriteriaElement

Definition at line 144 of file online.php.

References $criteria, $result, $ret, and $sql.

XoopsOnlineHandler::write	(		$uid,
			$uname,
			$time,
			$module,
			$ip
	)

Write online information to the database

Parameters

int	$uid	UID of the active user
string	$uname	Username
string	$timestamp
string	$module	Current module
string	$ip	User's IP adress

Returns

bool TRUE on success

Definition at line 60 of file online.php.

References $module, $sql, $time, $uid, and $uname.

XoopsOnlineHandler::XoopsOnlineHandler

(

&

$db

)

Constructor

Parameters

object

&$db

XoopsHandlerFactory

Definition at line 44 of file online.php.

References $db.

Member Data Documentation

XoopsOnlineHandler::$db

Definition at line 37 of file online.php.

---

The documentation for this class was generated from the following file:

• L:/0xoops/xoops-2.5.6/htdocs/kernel/online.php