eZPublish  4.5
ezpSessionHandler Class Reference
+ Inheritance diagram for ezpSessionHandler:

Public Member Functions

 __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...
 
 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 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...
 

Constructor & Destructor Documentation

ezpSessionHandler::__construct (   $userHasCookie = false)

__construct

Parameters
bool$userHasCookie

Member Function Documentation

ezpSessionHandler::cleanup ( )
abstract

Remove all session data Callback: "cleanup_[pre|post]" eZDB $db.

Returns
bool
ezpSessionHandler::close ( )

Session close handler.

Returns
bool
static ezpSessionHandler::count ( )
static

Counts the number of session and returns it.

Returns
int Returns -1 if handler does not support this.
static ezpSessionHandler::dbRequired ( )
static

Signals that handler requires db instance.

Returns
bool
ezpSessionHandler::deleteByUserIDs ( array  $userIDArray)
abstract

Remove all session data for a specific user.

Parameters
array(int)$userIDArray
ezpSessionHandler::destroy (   $sessionId)
abstract

Session destroy handler Callback: "destroy_[pre|post]" eZDB $db string $sessionId string $escKey.

Parameters
string$sessionId
Returns
bool
ezpSessionHandler::gc (   $maxLifeTime)
abstract

Session gc (garbageCollector) handler Callback: "gc_[pre|post]" eZDB $db int $maxLifeTime.

Parameters
int$maxLifeTimeIn seconds
Returns
bool
static ezpSessionHandler::hasBackendAccess ( )
static

Signals that handler has direct access to backend, thus is cable of supporting features like gc, cleanup, delete & count.

Returns
bool
ezpSessionHandler::isConnected ( )

Checks if session handler is connected with backend.

Returns
bool
ezpSessionHandler::open (   $savePath,
  $sessionName 
)

Session open handler.

Parameters
string$savePath
string$sessionName
Returns
bool
ezpSessionHandler::read (   $sessionId)
abstract

Session read handler.

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

Regenerate session id Callback (when $updateBackendData is true): "regenerate_[pre|post]" eZDB $db string $escNewKey string $escOldKey int $escUserID.

Parameters
bool$updateBackendDataTrue if we want to keep session data with the new session id
Returns
bool
ezpSessionHandler::setSaveHandler ( )

Set it self as save handler.

Returns
bool
ezpSessionHandler::write (   $sessionId,
  $sessionData 
)
abstract

Session write handler.

Parameters
string$sessionId
string$sessionDataBinary session data
Returns
bool

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