Open Journal Systems  3.3.0
SessionDAO Class Reference
Inheritance diagram for SessionDAO:
DAO

Public Member Functions

 deleteAllSessions ()
 
 deleteById ($sessionId)
 
 deleteByLastUsed ($lastUsed, $lastUsedRemember=0)
 
 deleteByUserId ($userId)
 
 deleteObject (&$session)
 
getSession ($sessionId)
 
 insertObject ($session)
 
 newDataObject ()
 
 sessionExistsById ($sessionId)
 
 updateObject (&$session)
 
- Public Member Functions inherited from DAO
 __construct ($dataSource=null, $callHooks=true)
 
 concat ()
 
 convertFromDB ($value, $type)
 
 convertToDB ($value, &$type)
 
 dateFromDB ($d)
 
 datetimeFromDB ($dt)
 
 datetimeToDB ($dt)
 
 dateToDB ($d)
 
 flushCache ()
 
 formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
 
 getAdditionalFieldNames ()
 
 getAffectedRows ()
 
 getDataObjectSettings ($tableName, $idFieldName, $idFieldValue, $dataObject)
 
 getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getLocaleFieldNames ()
 
 getType ($value)
 
 handleError ($dataSource, $sql)
 
 nullOrInt ($value)
 
 replace ($table, $arrFields, $keyCols)
 
retrieve ($sql, $params=false, $callHooks=true)
 
retrieveCached ($sql, $params=false, $secsToCache=3600, $callHooks=true)
 
retrieveLimit ($sql, $params=false, $numRows=false, $offset=false, $callHooks=true)
 
retrieveRange ($sql, $params=false, $dbResultRange=null, $callHooks=true)
 
 setCacheDir ()
 
 setDataSource ($dataSource)
 
 update ($sql, $params=false, $callHooks=true, $dieOnError=true)
 
 updateDataObjectSettings ($tableName, $dataObject, $idArray)
 

Additional Inherited Members

- Static Public Member Functions inherited from DAO
static getDataChangedEvent ($elementId=null, $parentElementId=null, $content='')
 
- Data Fields inherited from DAO
 $_dataSource
 
- Protected Member Functions inherited from DAO
 _getInsertId ($table='', $id='')
 

Detailed Description

Operations for retrieving and modifying Session objects.

See also
Session

Definition at line 20 of file SessionDAO.inc.php.

Member Function Documentation

◆ deleteAllSessions()

SessionDAO::deleteAllSessions ( )

Delete all sessions.

Definition at line 166 of file SessionDAO.inc.php.

References DAO\update().

◆ deleteById()

SessionDAO::deleteById (   $sessionId)

Delete a session by ID.

Parameters
$sessionIdstring

Definition at line 126 of file SessionDAO.inc.php.

References DAO\update().

Referenced by deleteObject().

◆ deleteByLastUsed()

SessionDAO::deleteByLastUsed (   $lastUsed,
  $lastUsedRemember = 0 
)

Delete all sessions older than the specified time.

Parameters
$lastUsedint cut-off time in seconds for not-remembered sessions
$lastUsedRememberint optional, cut-off time in seconds for remembered sessions

Definition at line 149 of file SessionDAO.inc.php.

References DAO\update().

◆ deleteByUserId()

SessionDAO::deleteByUserId (   $userId)

Delete sessions by user ID.

Parameters
$userIdstring

Definition at line 137 of file SessionDAO.inc.php.

References DAO\update().

◆ deleteObject()

SessionDAO::deleteObject ( $session)

Delete a session.

Parameters
$sessionSession

Definition at line 118 of file SessionDAO.inc.php.

References deleteById().

◆ getSession()

& SessionDAO::getSession (   $sessionId)

Retrieve a session by ID.

Parameters
$sessionIdstring
Returns
Session

Definition at line 34 of file SessionDAO.inc.php.

References newDataObject(), and DAO\retrieve().

◆ insertObject()

SessionDAO::insertObject (   $session)

Insert a new session.

Parameters
$sessionSession

Definition at line 64 of file SessionDAO.inc.php.

References DAO\update().

◆ newDataObject()

SessionDAO::newDataObject ( )

Instantiate and return a new data object.

Definition at line 25 of file SessionDAO.inc.php.

Referenced by getSession().

◆ sessionExistsById()

SessionDAO::sessionExistsById (   $sessionId)

Check if a session exists with the specified ID.

Parameters
$sessionIdstring
Returns
boolean

Definition at line 175 of file SessionDAO.inc.php.

References DAO\retrieve().

◆ updateObject()

SessionDAO::updateObject ( $session)

Update an existing session.

Parameters
$sessionSession

Definition at line 87 of file SessionDAO.inc.php.

References DAO\update().


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