eZPublishCommunityProject(LegacyStack)  2013.9
ezpSessionHandlerDB Class Reference
+ Inheritance diagram for ezpSessionHandlerDB:
+ Collaboration diagram for ezpSessionHandlerDB:

Public Member Functions

 cleanup ()
 Remove all session data (Truncate table) More...
 
 deleteByUserIDs (array $userIDArray)
 Remove all session data for a specific user. More...
 
 destroy ($sessionId)
 Session destroy handler. More...
 
 gc ($maxLifeTime)
 Session gc (garbageCollector) handler. More...
 
 isConnected ()
 Checks if session handler is connected with backend. More...
 
 read ($sessionId)
 Session read handler. More...
 
 regenerate ($updateBackendData=true)
 Regenerate session id. More...
 
 write ($sessionId, $sessionData)
 Session write handler. More...
 
- Public Member Functions inherited from ezpSessionHandler
 __construct ($userHasCookie=false)
 __construct More...
 
 cleanup ()
 Remove all session data Callback: "cleanup_[pre|post]" eZDB $db. More...
 
 close ()
 Session close handler. More...
 
 deleteByUserIDs (array $userIDArray)
 Remove all session data for a specific user. More...
 
 destroy ($sessionId)
 Session destroy handler Callback: "destroy_[pre|post]" eZDB $db string $sessionId string $escKey. More...
 
 gc ($maxLifeTime)
 Session gc (garbageCollector) handler Callback: "gc_[pre|post]" eZDB $db int $maxLifeTime. More...
 
 isConnected ()
 Checks if session handler is connected with backend. More...
 
 open ($savePath, $sessionName)
 Session open handler. More...
 
 read ($sessionId)
 Session read handler. More...
 
 regenerate ($updateBackendData=true)
 Regenerate session id Callback (when $updateBackendData is true): "regenerate_[pre|post]" eZDB $db string $escNewKey string $escOldKey int $escUserID. More...
 
 sessionStart ()
 Starts the session. More...
 
 setSaveHandler ()
 Set it self as save handler. More...
 
 write ($sessionId, $sessionData)
 Session write handler. More...
 

Static Public Member Functions

static count ()
 Counts the number of session and returns it. More...
 
- Static Public Member Functions inherited from ezpSessionHandler
static count ()
 Counts the number of session and returns it. More...
 
static dbRequired ()
 Signals that handler requires db instance. More...
 
static hasBackendAccess ()
 Signals that handler has direct access to backend, thus is cable of supporting features like gc, cleanup, delete & count. More...
 

Public Attributes

 $gcSessionsPrIteration = 50
 
const GC_MAX_EXECUTION_TIME = 300
 
const GC_MAX_EXECUTION_TIME_CLI = 3000
 
const GC_TIMEOUT_MARGIN = 5
 

Member Function Documentation

ezpSessionHandlerDB::cleanup ( )

Remove all session data (Truncate table)

Returns
bool
static ezpSessionHandlerDB::count ( )
static

Counts the number of session and returns it.

Returns
int|null Returns null if handler does not support this.

Referenced by read(), and write().

ezpSessionHandlerDB::deleteByUserIDs ( array  $userIDArray)

Remove all session data for a specific user.

Parameters
array(int)$userIDArray
ezpSessionHandlerDB::destroy (   $sessionId)

Session destroy handler.

Parameters
string$sessionId
Returns
bool

Referenced by deleteByUserIDs().

ezpSessionHandlerDB::gc (   $maxLifeTime)

Session gc (garbageCollector) handler.

Parameters
int$maxLifeTime
Returns
bool
ezpSessionHandlerDB::isConnected ( )

Checks if session handler is connected with backend.

Returns
bool
ezpSessionHandlerDB::read (   $sessionId)

Session read handler.

Parameters
string$sessionId
Returns
string|false Binary session data
ezpSessionHandlerDB::regenerate (   $updateBackendData = true)

Regenerate session id.

Parameters
bool$updateBackendData(true if we want to keep session data with the new session id)
Returns
bool
ezpSessionHandlerDB::write (   $sessionId,
  $sessionData 
)

Session write handler.

Parameters
string$sessionId
string$sessionDataBinary session data
Returns
bool

Member Data Documentation

ezpSessionHandlerDB::$gcSessionsPrIteration = 50
const ezpSessionHandlerDB::GC_MAX_EXECUTION_TIME = 300
const ezpSessionHandlerDB::GC_MAX_EXECUTION_TIME_CLI = 3000
const ezpSessionHandlerDB::GC_TIMEOUT_MARGIN = 5

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