Support Joomla!

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

 Class JTableSession

Description

Session table

  • since: 1.0

Located in /joomla/database/table/session.php (line 25)

Class JObject   (Subpackage Base)

Abstract class JTable
   
   Class JTableSession   (Subpackage Table)
Variable Summary
Variable string $data
Variable time $gid
Variable int $guest
Variable string $time
Variable string $userid
Variable string $username
Variable string $usertype
Method Summary
Constructor JTableSession __construct (database &$db)
Method true delete ([ $oid = null])
Method void destroy ( $userId, [ $clientIds = array()])
Method boolean exists (int $userid)
Method void insert ( $sessionId,  $clientId)
Method mixed purge ([int $maxLifetime = 1440])
Method void update ([ $updateNulls = false])
Variables
int $client_id = null (line 73)
string $data = null (line 79)
time $gid = null (line 61)
int $guest = null (line 67)
int $session_id = null (line 31)
  • var: Primary key
string $time = null (line 37)
string $userid = null (line 43)
string $username = null (line 55)
string $usertype = null (line 49)

Inherited Variables

Inherited from JTable

Variable JTable::$_db
Variable JTable::$_tbl
Variable JTable::$_tbl_key

Inherited from JObject

Variable JObject::$_errors
Methods
Constructor __construct (line 85)

Constructor

JTableSession __construct (database &$db)
  • database &$db: A database connector object

Redefinition of:
JTable::__construct()
Object constructor to set table and key field
delete (line 187)

Overloaded delete method

We must override it because of the non-integer primary key

  • return: if successful otherwise returns and error message
  • access: public
true delete ([ $oid = null])
  • $oid

Redefinition of:
JTable::delete()
Default delete method
destroy (line 126)

Destroys the pesisting session

void destroy ( $userId, [ $clientIds = array()])
  • $userId
  • $clientIds
exists (line 165)

Find out if a user has a one or more active sessions

  • return: True if a session for this user exists
boolean exists (int $userid)
  • int $userid: The identifier of the user
insert (line 94)
void insert ( $sessionId,  $clientId)
  • $sessionId
  • $clientId
purge (line 150)

Purge old sessions

  • return: Resource on success, null on fail
mixed purge ([int $maxLifetime = 1440])
  • int $maxLifetime: Session age in seconds
update (line 110)
void update ([ $updateNulls = false])
  • $updateNulls

Inherited Methods

Inherited From JTable

 JTable::__construct()
 JTable::addIncludePath()
 JTable::bind()
 JTable::canDelete()
 JTable::check()
 JTable::checkin()
 JTable::checkout()
 JTable::delete()
 JTable::getDBO()
 JTable::getInstance()
 JTable::getKeyName()
 JTable::getNextOrder()
 JTable::getTableName()
 JTable::hit()
 JTable::isCheckedOut()
 JTable::load()
 JTable::move()
 JTable::publish()
 JTable::reorder()
 JTable::reset()
 JTable::save()
 JTable::setDBO()
 JTable::store()
 JTable::toXML()

Inherited From JObject

 JObject::JObject()
 JObject::__construct()
 JObject::get()
 JObject::getError()
 JObject::getErrors()
 JObject::getProperties()
 JObject::getPublicProperties()
 JObject::set()
 JObject::setError()
 JObject::setProperties()
 JObject::toString()

Documentation generated on Sat, 14 Nov 2009 11:18:56 +0000 by phpDocumentor 1.3.1