\Symfony\Component\HttpFoundation\Session\Storage\HandlerMongoDbSessionHandler

Session handler using the mongodb/mongodb package and MongoDB driver extension.

Summary

Methods
Properties
Constants
open()
validateId()
read()
write()
destroy()
__construct()
close()
gc()
updateTimestamp()
No public properties found
No constants found
doRead()
doWrite()
doDestroy()
getMongo()
No protected properties found
N/A
getCollection()
$sessionName
$prefetchId
$prefetchData
$newSessionId
$igbinaryEmptyData
$mongo
$collection
$options
N/A

Properties

$sessionName

$sessionName

$prefetchId

$prefetchId

$prefetchData

$prefetchData

$newSessionId

$newSessionId

$igbinaryEmptyData

$igbinaryEmptyData

$mongo

$mongo

$collection

$collection : \MongoDB\Collection

Type

\MongoDB\Collection —

$options

$options : array

Type

array

Methods

open()

open(mixed  $savePath, mixed  $sessionName) : bool

Parameters

mixed $savePath
mixed $sessionName

Returns

bool —

validateId()

validateId(mixed  $sessionId) : bool

Parameters

mixed $sessionId

Returns

bool —

read()

read(mixed  $sessionId) : string

Parameters

mixed $sessionId

Returns

string —

write()

write(mixed  $sessionId, mixed  $data) : bool

Parameters

mixed $sessionId
mixed $data

Returns

bool —

destroy()

destroy(mixed  $sessionId) : bool

Parameters

mixed $sessionId

Returns

bool —

__construct()

__construct(\MongoDB\Client  $mongo, array  $options) : mixed

Constructor.

List of available options:

  • database: The name of the database [required]
  • collection: The name of the collection [required]
  • id_field: The field name for storing the session id [default: _id]
  • data_field: The field name for storing the session data [default: data]
  • time_field: The field name for storing the timestamp [default: time]
  • expiry_field: The field name for storing the expiry-timestamp [default: expires_at].

It is strongly recommended to put an index on the expiry_field for garbage-collection. Alternatively it's possible to automatically expire the sessions in the database as described below:

A TTL collections can be used on MongoDB 2.2+ to cleanup expired sessions automatically. Such an index can for example look like this:

db.<session-collection>.createIndex(
    { "<expiry-field>": 1 },
    { "expireAfterSeconds": 0 }
)

More details on: https://docs.mongodb.org/manual/tutorial/expire-data/

If you use such an index, you can drop gc_probability to 0 since no garbage-collection is required.

Parameters

\MongoDB\Client $mongo
array $options

Throws

\InvalidArgumentException

When "database" or "collection" not provided

Returns

mixed —

close()

close() : bool

Returns

bool —

gc()

gc(mixed  $maxlifetime) : int|false

Parameters

mixed $maxlifetime

Returns

int|false —

updateTimestamp()

updateTimestamp(mixed  $sessionId, mixed  $data) : bool

Parameters

mixed $sessionId
mixed $data

Returns

bool —

doRead()

doRead(string  $sessionId) : string

Parameters

string $sessionId

Returns

string —

doWrite()

doWrite(string  $sessionId, string  $data) : bool

Parameters

string $sessionId
string $data

Returns

bool —

doDestroy()

doDestroy(string  $sessionId) : bool

Parameters

string $sessionId

Returns

bool —

getMongo()

getMongo() : \MongoDB\Client

Returns

\MongoDB\Client —

getCollection()

getCollection() : \MongoDB\Collection

Returns

\MongoDB\Collection —