Open Journal Systems  2.4.8
 All Classes Namespaces Functions Variables Groups Pages
SessionManager Class Reference

Public Member Functions

 close ()
 
 destroy ($sessionId)
 
 gc ($maxlifetime)
 
getManager ()
 
getUserSession ()
 
 open ()
 
 read ($sessionId)
 
 regenerateSessionId ()
 
 SessionManager (&$sessionDao, &$request)
 
 updateSessionCookie ($sessionId=false, $expireTime=0)
 
 updateSessionLifetime ($expireTime=0)
 
 write ($sessionId, $data)
 

Detailed Description

Implements PHP methods for a custom session storage handler (see http://php.net/session).

Definition at line 17 of file SessionManager.inc.php.

Member Function Documentation

SessionManager::close ( )

Close a session. Does nothing; only here to satisfy PHP session handler requirements.

Returns
boolean

Definition at line 158 of file SessionManager.inc.php.

SessionManager::destroy (   $sessionId)

Destroy (delete) a session.

Parameters
$sessionIdstring
Returns
boolean

Definition at line 198 of file SessionManager.inc.php.

SessionManager::gc (   $maxlifetime)

Garbage collect unused session data. TODO: Use $maxlifetime instead of assuming 24 hours?

Parameters
$maxlifetimeint the number of seconds after which data will be seen as "garbage" and cleaned up
Returns
boolean

Definition at line 208 of file SessionManager.inc.php.

References Config\getVar().

& SessionManager::getUserSession ( )

Get the session associated with the current request.

Returns
Session

Definition at line 140 of file SessionManager.inc.php.

SessionManager::open ( )

Open a session. Does nothing; only here to satisfy PHP session handler requirements.

Returns
boolean

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

SessionManager::read (   $sessionId)

Read session data from database.

Parameters
$sessionIdstring
Returns
boolean

Definition at line 167 of file SessionManager.inc.php.

SessionManager::regenerateSessionId ( )

Regenerate the session ID for the current user session. This is useful to guard against the "session fixation" form of hijacking by changing the user's session ID after they have logged in (in case the original session ID had been pre-populated).

Returns
boolean

Definition at line 244 of file SessionManager.inc.php.

References updateSessionCookie().

SessionManager::SessionManager ( $sessionDao,
$request 
)

Constructor. Initialize session configuration and set PHP session handlers. Attempts to rejoin a user's session if it exists, or create a new session otherwise.

Parameters
$sessionDaoSessionDAO
$requestPKPRequest

Definition at line 32 of file SessionManager.inc.php.

References Config\getVar(), and updateSessionLifetime().

Referenced by getManager().

SessionManager::updateSessionCookie (   $sessionId = false,
  $expireTime = 0 
)

Resubmit the session cookie.

Parameters
$sessionIdstring new session ID (or false to keep current ID)
$expireTimeint new expiration time in seconds (0 = current session)
Returns
boolean

Definition at line 218 of file SessionManager.inc.php.

Referenced by regenerateSessionId(), and updateSessionLifetime().

SessionManager::updateSessionLifetime (   $expireTime = 0)

Change the lifetime of the current session cookie.

Parameters
$expireTimeint new expiration time in seconds (0 = current session)
Returns
boolean

Definition at line 284 of file SessionManager.inc.php.

References updateSessionCookie().

Referenced by SessionManager().

SessionManager::write (   $sessionId,
  $data 
)

Save session data to database.

Parameters
$sessionIdstring
$dataarray
Returns
boolean

Definition at line 183 of file SessionManager.inc.php.


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