Horde_SessionHandler_Storage_Mongo
extends Horde_SessionHandler_Storage
in package
implements
Horde_Mongo_Collection_Index
MongoDB storage driver.
Tags
Table of Contents
Interfaces
- Horde_Mongo_Collection_Index
Constants
Properties
- $readonly : bool
- Access session read-only?
- $_db : MongoCollection
- MongoCollection object for the storage table.
- $_indices : array<string|int, mixed>
- Indices list.
- $_locked : bool
- Is the session locked.
- $_params : array<string|int, mixed>
- Hash containing connection parameters.
Methods
- __construct() : mixed
- Constructor.
- __sleep() : mixed
- Storage objects do not support serialization.
- checkMongoIndices() : mixed
- close() : mixed
- Close the backend.
- createMongoIndices() : mixed
- destroy() : bool
- Destroy the data for a particular session identifier in the backend.
- gc() : bool
- Garbage collect stale sessions from the backend.
- getSessionIDs() : array<string|int, mixed>
- Get a list of the valid session identifiers.
- open() : mixed
- Open the backend.
- read() : string
- Read the data for a particular session identifier from the backend.
- setLogger() : mixed
- Set the logger object.
- write() : bool
- Write session data to the backend.
- isValidSessionID() : bool
- Validate a session id against the schema mentioned in the PHP manual page for session_id()
Constants
DATA
public
mixed
DATA
= 'data'
LOCK
public
mixed
LOCK
= 'lock'
MODIFIED
public
mixed
MODIFIED
= 'ts'
SID
public
mixed
SID
= 'sid'
Properties
$readonly
Access session read-only?
public
bool
$readonly
= \false
$_db
MongoCollection object for the storage table.
protected
MongoCollection
$_db
$_indices
Indices list.
protected
array<string|int, mixed>
$_indices
= array('index_ts' => array(self::MODIFIED => 1))
$_locked
Is the session locked.
protected
bool
$_locked
= \false
$_params
Hash containing connection parameters.
protected
array<string|int, mixed>
$_params
= array()
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $params = array() ]) : mixed
Parameters
- $params : array<string|int, mixed> = array()
-
Parameters:
collection: (string) The collection to store data in. mongo_db: (Horde_Mongo_Client) [REQUIRED] The Mongo client object.
__sleep()
Storage objects do not support serialization.
public
__sleep() : mixed
checkMongoIndices()
public
checkMongoIndices() : mixed
close()
Close the backend.
public
close() : mixed
createMongoIndices()
public
createMongoIndices() : mixed
destroy()
Destroy the data for a particular session identifier in the backend.
public
destroy(mixed $id) : bool
Parameters
- $id : mixed
-
The session identifier.
Return values
bool —True on success, false otherwise.
gc()
Garbage collect stale sessions from the backend.
public
gc([mixed $maxlifetime = 300 ]) : bool
Parameters
- $maxlifetime : mixed = 300
-
The maximum age of a session.
Return values
bool —True on success, false otherwise.
getSessionIDs()
Get a list of the valid session identifiers.
public
getSessionIDs() : array<string|int, mixed>
Return values
array<string|int, mixed> —A list of valid session identifiers.
open()
Open the backend.
public
open([mixed $save_path = null ][, mixed $session_name = null ]) : mixed
Parameters
- $save_path : mixed = null
-
The path to the session object.
- $session_name : mixed = null
-
The name of the session.
read()
Read the data for a particular session identifier from the backend.
public
read(mixed $id) : string
Parameters
- $id : mixed
-
The session identifier.
Return values
string —The session data.
setLogger()
Set the logger object.
public
setLogger(Horde_Log_Logger $log) : mixed
Parameters
- $log : Horde_Log_Logger
write()
Write session data to the backend.
public
write(mixed $id, mixed $session_data) : bool
Parameters
- $id : mixed
-
The session identifier.
- $session_data : mixed
-
The session data.
Return values
bool —True on success, false otherwise.
isValidSessionID()
Validate a session id against the schema mentioned in the PHP manual page for session_id()
protected
isValidSessionID(string $id) : bool
Parameters
- $id : string