Class JTableSession

Description

Session table

  • deprecated: 13.3 (Platform) & 4.0 (CMS) - Use SQL queries to interact with the session table.
  • since: 11.1

Located in /libraries/legacy/table/session.php (line 20)

JObject
   |
   --JTable
      |
      --JTableSession
Method Summary
 JTableSession __construct (JDatabaseDriver $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

  • deprecated: 13.3 Use SQL queries to interact with the session table.
  • since: 11.1
  • access: public
JTableSession __construct (JDatabaseDriver $db)

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 189)

Overloaded delete method

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

  • return: True if successful otherwise an error message
  • deprecated: 13.3 Use SQL queries to interact with the session table.
  • 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 108)

Destroys the pre-existing session

  • return: True on success.
  • deprecated: 13.3 Use SQL queries to interact with the session table.
  • 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 159)

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

  • return: True if a session for this user exists
  • deprecated: 13.3 Use SQL queries to interact with the session table.
  • since: 11.1
  • access: public
boolean exists (integer $userid)
  • integer $userid: The identifier of the user
insert (line 50)

Insert a session

  • return: True on success
  • deprecated: 13.3 Use SQL queries to interact with the session table.
  • 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 138)

Purge old sessions

  • return: Resource on success, null on fail
  • deprecated: 13.3 Use SQL queries to interact with the session table.
  • since: 11.1
  • access: public
mixed purge ([integer $maxLifetime = 1440])
  • integer $maxLifetime: Session age in seconds
update (line 80)

Updates the session

  • return: True on success.
  • deprecated: 13.3 Use SQL queries to interact with the session table.
  • 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::appendPrimaryKeys()
 JTable::attachObserver()
 JTable::bind()
 JTable::check()
 JTable::checkIn()
 JTable::checkOut()
 JTable::delete()
 JTable::getDbo()
 JTable::getFields()
 JTable::getInstance()
 JTable::getKeyName()
 JTable::getNextOrder()
 JTable::getObserverOfClass()
 JTable::getPrimaryKey()
 JTable::getRules()
 JTable::getTableName()
 JTable::hasPrimaryKey()
 JTable::hit()
 JTable::isCheckedOut()
 JTable::load()
 JTable::move()
 JTable::publish()
 JTable::reorder()
 JTable::reset()
 JTable::save()
 JTable::setDBO()
 JTable::setRules()
 JTable::store()
 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()

Documentation generated on Tue, 19 Nov 2013 15:12:53 +0100 by phpDocumentor 1.4.3