Property | Type | Description | |
---|---|---|---|
$changed | boolean | If true, indicates the session data has changed. |
Property | Type | Description | |
---|---|---|---|
$_connected | boolean | Has a connection been made to the backend? | |
$_logger | Horde_Log_Logger | A logger instance. | |
$_params | array | Configuration parameters. | |
$_sig | string | Initial session data signature. | |
$_storage | Horde_SessionHandler_Storage | The storage object. |
Method | Description | |
---|---|---|
__construct ( Horde_SessionHandler_Storage $storage, array $params = [] ) | Constructor. | |
__destruct ( ) | Destructor. | |
close ( ) : boolean | 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. | |
getSessionsInfo ( ) : array | Returns a list of authenticated users and data about their session. | |
open ( string $save_path = null, string $session_name = null ) : boolean | Open the backend. | |
read ( string $id ) : string | Read the data for a particular session identifier from the backend. | |
write ( string $id, string $session_data ) : boolean | Write session data to the backend. |
public __construct ( Horde_SessionHandler_Storage $storage, array $params = [] ) | ||
$storage | Horde_SessionHandler_Storage | The storage object. |
$params | array | Configuration parameters:
- logger: (Horde_Log_Logger) A logger instance. DEFAULT: No logging - no_md5: (boolean) If true, does not do MD5 signatures of the session to determine if the session has changed (calling code is responsible for marking $changed as true when the session data has changed). DEFAULT: false - noset: (boolean) If true, don't set the save handler. DEFAULT: false - parse: (callback) A callback function that parses session information into an array. Is passed the raw session data as the only argument; expects either false or an array of session data as a return. DEFAULT: No |
public getSessionIDs ( ) : array | ||
return | array | A list of valid session identifiers. |
public getSessionsInfo ( ) : array | ||
return | array | For authenticated users, the sessionid as a key and the session information as value. If no parsing function was provided, will always return an empty array. |
protected bool $_connected | ||
return | boolean |
protected Horde_Log_Logger $_logger | ||
return | Horde_Log_Logger |
protected Horde_SessionHandler_Storage $_storage | ||
return | Horde_SessionHandler_Storage |
public bool $changed | ||
return | boolean |