• Home
  • Horde_SessionHandler_Storage

PHP Class Horde_SessionHandler_Storage, horde

Author: Michael Slusarz ([email protected])
显示文件 Open project: horde/horde Class Usage Examples

Public Properties

Property Type Description
$readonly boolean Access session read-only?

Protected Properties

Property Type Description
$_params array Hash containing connection parameters.

Public Methods

Method Description
__construct ( array $params = [] ) Constructor.
__sleep ( ) Storage objects do not support serialization.
close ( ) Close the backend.
destroy ( string $id ) : boolean Destroy the data for a particular session identifier in the backend.
gc ( integer $maxlifetime = 300 ) : boolean Garbage collect stale sessions from the backend.
getSessionIDs ( ) : array Get a list of the valid session identifiers.
open ( string $save_path = null, string $session_name = null ) Open the backend.
read ( string $id ) : string Read the data for a particular session identifier from the backend.
setLogger ( Horde_Log_Logger $log ) Set the logger object.
write ( string $id, string $session_data ) : boolean Write session data to the backend.

Method Details

__construct() public method

Constructor.
public __construct ( array $params = [] )
$params array Configuration parameters.

__sleep() public method

Storage objects do not support serialization.
public __sleep ( )

close() abstract public method

Close the backend.
abstract public close ( )

destroy() abstract public method

This method should only be called internally by PHP via session_set_save_handler().
abstract public destroy ( string $id ) : boolean
$id string The session identifier.
return boolean True on success, false otherwise.

gc() abstract public method

This method should only be called internally by PHP via session_set_save_handler().
abstract public gc ( integer $maxlifetime = 300 ) : boolean
$maxlifetime integer The maximum age of a session.
return boolean True on success, false otherwise.

getSessionIDs() abstract public method

Get a list of the valid session identifiers.
abstract public getSessionIDs ( ) : array
return array A list of valid session identifiers.

open() abstract public method

Open the backend.
abstract public open ( string $save_path = null, string $session_name = null )
$save_path string The path to the session object.
$session_name string The name of the session.

read() abstract public method

Read the data for a particular session identifier from the backend.
abstract public read ( string $id ) : string
$id string The session identifier.
return string The session data.

setLogger() public method

Set the logger object.
Deprecation:
public setLogger ( Horde_Log_Logger $log )
$log Horde_Log_Logger

write() abstract public method

Write session data to the backend.
abstract public write ( string $id, string $session_data ) : boolean
$id string The session identifier.
$session_data string The session data.
return boolean True on success, false otherwise.

Property Details

$_params protected_oe property

Hash containing connection parameters.
protected array $_params
return array

$readonly public_oe property

Access session read-only?
public bool $readonly
return boolean