XoopsOnlineHandler Class Reference

Inheritance diagram for XoopsOnlineHandler:

Public Member Functions
	__construct (Connection $db=null)
	destroy ($uid)
	gc ($expire)
	write ($uid, $uname, $time, $module, $ip)
Public Member Functions inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
	__call ($name, $args)
	cleanOrphan ($table_link= '', $field_link= '', $field_object= '')
	create ($isNew=true)
	delete (XoopsObject $object, $force=false)
	deleteAll (CriteriaElement $criteria, $force=true, $asObject=false)
	deleteByLink (CriteriaElement $criteria=null)
	get ($id=null, $fields=null)
	getAll (CriteriaElement $criteria=null, $fields=null, $asObject=true, $id_as_key=true)
	getByLink (CriteriaElement $criteria=null, $fields=null, $asObject=true, $field_link=null, $field_object=null)
	getCount (CriteriaElement $criteria=null)
	getCountByLink (CriteriaElement $criteria=null)
	getCounts (CriteriaElement $criteria=null)
	getCountsByLink (CriteriaElement $criteria=null)
	getIds (CriteriaElement $criteria=null)
	getList (CriteriaElement $criteria=null, $limit=0, $start=0)
	getObjects (CriteriaElement $criteria=null, $id_as_key=false, $as_object=true)
	insert (XoopsObject $object, $force=true)
	loadHandler ($name, $args=null)
	setHandler ($handler=null, $args=null, $path=null)
	synchronization ($table_link= '', $field_link= '', $field_object= '')
	updateAll ($fieldname, $fieldvalue, CriteriaElement $criteria, $force=false)
	updateByLink ($data, CriteriaElement $criteria=null)
Public Member Functions inherited from Xoops\Core\Kernel\XoopsObjectHandler
	create ()
	delete (XoopsObject $object, $force=true)
	get ($int_id)
	insert (XoopsObject $object, $force=true)

Additional Inherited Members
Public Attributes inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
	$className
	$field_link
	$field_object
	$identifierName
	$keyName
	$keyName_link
	$table
	$table_link
Public Attributes inherited from Xoops\Core\Kernel\XoopsObjectHandler
	$db2
Protected Member Functions inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
	__construct (Connection $db=null, $table= '', $className= '', $keyName= '', $identifierName= '')
Protected Member Functions inherited from Xoops\Core\Kernel\XoopsObjectHandler
	__construct (Connection $db=null)
Protected Attributes inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
	$handler

Detailed Description

Definition at line 108 of file online.php.

Constructor & Destructor Documentation

XoopsOnlineHandler::__construct

(

Connection

$db = null

)

Constructor

Parameters

Connection | null

$db

Connection

Definition at line 115 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 175 of file online.php.

References $criteria, $uid, and Xoops\Core\Kernel\XoopsPersistableObjectHandler\deleteAll().

Here is the call graph for this function:

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

Returns

bool

Definition at line 193 of file online.php.

References $criteria, and Xoops\Core\Kernel\XoopsPersistableObjectHandler\deleteAll().

Here is the call graph for this function:

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	$time	time
string	$module	Current module
string	$ip	User's IP adress

Returns

bool TRUE on success

Definition at line 131 of file online.php.

References $criteria, $module, $uid, and $uname.

---

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

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