XoopsOnlineHandler Class Reference

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

Data Fields
	$db

Detailed Description

Definition at line 14 of file online.php.

Constructor & Destructor Documentation

__construct()

__construct

(

&

$db

)

Constructor

Parameters

object

&$db

XoopsHandlerFactory

Definition at line 29 of file online.php.

Member Function Documentation

destroy()

destroy

(

$uid

)

Delete online information for a user

Parameters

int

$uid

UID

Returns

bool TRUE on success

Definition at line 80 of file online.php.

gc()

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 96 of file online.php.

getAll()

& 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 108 of file online.php.

getCount()

getCount

(

$criteria = null

)

Count the number of online users

Parameters

object

$criteria

CriteriaElement

Returns

bool

Definition at line 136 of file online.php.

write()

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

Write online information to the database

Parameters

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

Returns

bool TRUE on success

Definition at line 49 of file online.php.

XoopsOnlineHandler()

XoopsOnlineHandler

(

&

$db

)

Definition at line 33 of file online.php.

Field Documentation

$db

$db

Definition at line 23 of file online.php.

---

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

• html/kernel/online.php