Class JTableSession

Description

Session table

  • since: 11.1

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

JObject
   |
   --JTable
      |
      --JTableSession
Method Summary
JTableSession __construct (JDatabase &$db)
mixed delete ([integer $oid = null])
boolean destroy (integer $userId, [array $clientIds = array()])
boolean exists (integer $userid)
boolean insert (string $sessionId, integer $clientId)
mixed purge ([integer $maxLifetime = 1440])
boolean update ([boolean $updateNulls = false])
Variables
Methods
Constructor __construct (line 30)

Constructor

  • since: 11.1
  • access: public
JTableSession __construct (JDatabase &$db)
  • JDatabase &$db: A database connector object.

Redefinition of:
JTable::__construct()
Object constructor to set table and key fields. In most cases this will be overridden by child classes to explicitly set the table and key fields for a particular database table.
delete (line 180)

Overloaded delete method

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

  • return: True if successful otherwise an error message
  • since: 11.1
  • access: public
mixed delete ([integer $oid = null])
  • integer $oid: The object id (optional).

Redefinition of:
JTable::delete()
Method to delete a row from the database table by primary key value.
destroy (line 102)

Destroys the pre-existing session

  • return: True on success.
  • since: 11.1
  • access: public
boolean destroy (integer $userId, [array $clientIds = array()])
  • integer $userId: Identifier of the user for this session.
  • array $clientIds: Array of client ids for which session(s) will be destroyed
exists (line 152)

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

  • return: True if a session for this user exists
  • since: 11.1
  • access: public
boolean exists (integer $userid)
  • integer $userid: The identifier of the user
insert (line 48)

Insert a session

  • return: True on success
  • since: 11.1
  • access: public
boolean insert (string $sessionId, integer $clientId)
  • string $sessionId: The session id
  • integer $clientId: The id of the client application
purge (line 131)

Purge old sessions

  • return: Resource on success, null on fail
  • since: 11.1
  • access: public
mixed purge ([integer $maxLifetime = 1440])
  • integer $maxLifetime: Session age in seconds
update (line 76)

Updates the session

  • return: True on success.
  • since: 11.1
  • access: public
boolean update ([boolean $updateNulls = false])
  • boolean $updateNulls: True to update fields even if they are null.

Inherited Methods

Inherited From JTable

JTable::__construct()
JTable::addIncludePath()
JTable::bind()
JTable::canDelete()
JTable::check()
JTable::checkIn()
JTable::checkOut()
JTable::delete()
JTable::getDbo()
JTable::getFields()
JTable::getInstance()
JTable::getKeyName()
JTable::getNextOrder()
JTable::getRules()
JTable::getTableName()
JTable::hit()
JTable::isCheckedOut()
JTable::load()
JTable::move()
JTable::publish()
JTable::reorder()
JTable::reset()
JTable::save()
JTable::setDBO()
JTable::setRules()
JTable::store()
JTable::toXML()
JTable::_getAssetName()
JTable::_getAssetParentId()
JTable::_getAssetTitle()
JTable::_lock()
JTable::_unlock()

Inherited From JObject

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

Documentation generated on Mon, 25 Jun 2012 13:59:27 -0500 by phpDocumentor 1.4.4