XoopsOnlineHandler Class Reference

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

Data Fields
	$db
	$table

Constructor & Destructor Documentation

__construct()

__construct

(

XoopsDatabase

$db

)

Constructor

Parameters

XoopsDatabase

$db

XoopsHandlerFactory

Member Function Documentation

destroy()

destroy

(

$uid

)

Delete online information for a user

Parameters

int

$uid

UID

Returns

bool TRUE on success

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

getAll()

getAll

(

CriteriaElement

$criteria = null

)

Get an array of online information

Parameters

CriteriaElement | CriteriaCompo

$criteria

CriteriaElement

Returns

array Array of associative arrays of online information

getCount()

getCount

(

CriteriaElement

$criteria = null

)

Count the number of online users

Parameters

CriteriaElement | CriteriaCompo

$criteria

CriteriaElement

Returns

bool

write()

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

Write online information to the database

Parameters

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

Field Documentation

$db

$db

$table

$table

---

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

• C:/xoops2511b2/htdocs/kernel/online.php