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

open()

open(  $savePath,   $sessionName) 

{@inheritdoc}

Parameters

validateId()

validateId(  $sessionId) : boolean

Checks if a session identifier already exists or not.

Parameters

Returns

read()

read(  $sessionId) 

{@inheritdoc}

Parameters

write()

write(  $sessionId,   $data) 

{@inheritdoc}

Parameters

destroy()

destroy(  $sessionId) 

{@inheritdoc}

Parameters

__construct()

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

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>.ensureIndex(
    { "<expiry-field>": 1 },
    { "expireAfterSeconds": 0 }
)

More details on: http://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

Throws

\InvalidArgumentException

When MongoClient or Mongo instance not provided

\InvalidArgumentException

When "database" or "collection" not provided

close()

close() 

{@inheritdoc}

gc()

gc(  $maxlifetime) 

{@inheritdoc}

Parameters

updateTimestamp()

updateTimestamp(  $sessionId,   $data) 

{@inheritdoc}

Parameters

doRead()

doRead(string  $sessionId) : string

Parameters

Returns

doWrite()

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

Parameters

Returns

doDestroy()

doDestroy(string  $sessionId) : boolean

Parameters

Returns

getMongo()

getMongo() : \Mongo|\MongoClient|\MongoDB\Client

Return a Mongo instance.

Returns

getCollection()

getCollection() : \MongoCollection

Return a "MongoCollection" instance.

Returns

createDateTime()

createDateTime(integer  $seconds = null) : \MongoDate|\MongoDB\BSON\UTCDateTime

Create a date object using the class appropriate for the current mongo connection.

Return an instance of a MongoDate or \MongoDB\BSON\UTCDateTime

Parameters

Returns