Class MongoDbSessionHandler

MongoDB session handler

Symfony\Component\HttpFoundation\Session\Storage\Handler\MongoDbSessionHandler implements SessionHandlerInterface

Namespace: Symfony\Component\HttpFoundation\Session\Storage\Handler
Author: Markus Bachmann <markus.bachmann@bachi.biz>
Located at laravel/vendor/Symfony/Component/HttpFoundation/Session/Storage/Handler/MongoDbSessionHandler.php

Methods summary
`public`	# `__construct( Mongo\|MongoClient $mongo, array $options )` Constructor. 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] Parameters `$mongo` `Mongo\|MongoClient` $mongo A MongoClient or Mongo instance `$options` `array` $options An associative array of field options Throws `InvalidArgumentException` When MongoClient or Mongo instance not provided `InvalidArgumentException` When "database" or "collection" not provided
`public boolean`	# `open( string $savePath, string $sessionName )` Open session. Open session. Parameters `$savePath` `string` $savePath Save path. `$sessionName` `string` $sessionName Session Name. Returns `boolean` Throws `RuntimeException` If something goes wrong starting the session. Implementation of `SessionHandlerInterface::open()`
`public boolean`	# `close( )` Close session. Close session. Returns `boolean` Implementation of `SessionHandlerInterface::close()`
`public boolean`	# `destroy( string $sessionId )` Destroys this session. Destroys this session. Parameters `$sessionId` `string` $sessionId Session ID. Returns `boolean` Throws `RuntimeException` On fatal error. Implementation of `SessionHandlerInterface::destroy()`
`public boolean`	# `gc( integer $lifetime )` Garbage collection for storage. Garbage collection for storage. Parameters `$lifetime` `integer` $lifetime Max lifetime in seconds to keep sessions stored. Returns `boolean` Throws `RuntimeException` On fatal error. Implementation of `SessionHandlerInterface::gc()`
`public boolean`	# `write( string $sessionId, string $data )` {@inheritDoc] {@inheritDoc] Parameters `$sessionId` `string` $sessionId Session ID. `$data` `string` $data Session serialized data to save. Returns `boolean` Implementation of `SessionHandlerInterface::write()`
`public string`	# `read( string $sessionId )` Read session. Read session. Parameters `$sessionId` `string` $sessionId Returns `string` String as stored in persistent storage or empty string in all other cases. Throws `RuntimeException` On fatal error but not "record not found". Implementation of `SessionHandlerInterface::read()`
`private MongoCollection`	# `getCollection( )` Return a "MongoCollection" instance Return a "MongoCollection" instance Returns `MongoCollection`

Properties summary
`private Mongo`	`$mongo`		#
`private MongoCollection`	`$collection`		#
`private array`	`$options`		#