# MongoDbSessionHandler

class MongoDbSessionHandler extends AbstractSessionHandler

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

## Methods

`public` | `` | `open($savePath, $sessionName)` | {@inheritdoc} | from AbstractSessionHandler
`protected` | `string` | `doRead(string $sessionId)` | No description |
`protected` | `bool` | `doWrite(string $sessionId, string $data)` | No description |
`protected` | `bool` | `doDestroy(string $sessionId)` | No description |
`public` | `` | `validateId($sessionId)` | {@inheritdoc} | from AbstractSessionHandler
`public` | `` | `read($sessionId)` | {@inheritdoc} | from AbstractSessionHandler
`public` | `` | `write($sessionId, $data)` | {@inheritdoc} | from AbstractSessionHandler
`public` | `` | `destroy($sessionId)` | {@inheritdoc} | from AbstractSessionHandler
`public` | `` | `__construct(Client $mongo, array $options)` | Constructor. |
`public` | `` | `close()` | {@inheritdoc} |
`public` | `` | `gc($maxlifetime)` | {@inheritdoc} |
`public` | `` | `updateTimestamp($sessionId, $data)` | {@inheritdoc} |
`protected` | `Client` | `getMongo()` | No description |

## Details

in AbstractSessionHandler at line 32

### `open()`

`public open($savePath, $sessionName)`

{@inheritdoc}

#### Parameters

| `$savePath` |
| `$sessionName` |

at line 169

### `doRead()`

`protected string doRead(string $sessionId)`

#### Parameters

`string` | `$sessionId` |

#### Return Value

`string` |

at line 120

### `doWrite()`

`protected bool doWrite(string $sessionId, string $data)`

#### Parameters

`string` | `$sessionId` |
`string` | `$data` |

#### Return Value

`bool` |

at line 96

### `doDestroy()`

`protected bool doDestroy(string $sessionId)`

#### Parameters

`string` | `$sessionId` |

#### Return Value

`bool` |

in AbstractSessionHandler at line 67

### `validateId()`

`public validateId($sessionId)`

{@inheritdoc}

#### Parameters

| `$sessionId` |

in AbstractSessionHandler at line 78

### `read()`

`public read($sessionId)`

{@inheritdoc}

#### Parameters

| `$sessionId` |

in AbstractSessionHandler at line 101

### `write()`

`public write($sessionId, $data)`

{@inheritdoc}

#### Parameters

| `$sessionId` |
| `$data` |

in AbstractSessionHandler at line 118

### `destroy()`

`public destroy($sessionId)`

{@inheritdoc}

#### Parameters

| `$sessionId` |

at line 69

### `__construct()`

`public __construct(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

`Client` | `$mongo` | A MongoDB\Client instance
`array` | `$options` | An associative array of field options

#### Exceptions

InvalidArgumentException | When "database" or "collection" not provided

at line 88

### `close()`

`public close()`

{@inheritdoc}

at line 108

### `gc()`

`public gc($maxlifetime)`

{@inheritdoc}

#### Parameters

| `$maxlifetime` |

at line 142

### `updateTimestamp()`

`public updateTimestamp($sessionId, $data)`

{@inheritdoc}

#### Parameters

| `$sessionId` |
| `$data` |

at line 198

### `getMongo()`

`protected Client getMongo()`

#### Return Value

`Client` |

## Source code

    <?php

    /*
     * This file is part of the Symfony package.
     *
     * (c) Fabien Potencier <fabien@symfony.com>
     *
     * For the full copyright and license information, please view the LICENSE
     * file that was distributed with this source code.
     */

    namespace Symfony\Component\HttpFoundation\Session\Storage\Handler;

    /**
     * Session handler using the mongodb/mongodb package and MongoDB driver extension.
     *
     * @author Markus Bachmann <markus.bachmann@bachi.biz>
     *
     * @see https://packagist.org/packages/mongodb/mongodb
     * @see http://php.net/manual/en/set.mongodb.php
     */
    class MongoDbSessionHandler extends AbstractSessionHandler
    {
        private $mongo;

        /**
         * @var \MongoCollection
         */
        private $collection;

        /**
         * @var array
         */
        private $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.
         *
         * @param \MongoDB\Client $mongo   A MongoDB\Client instance
         * @param array           $options An associative array of field options
         *
         * @throws \InvalidArgumentException When "database" or "collection" not provided
         */
        public function __construct(\MongoDB\Client $mongo, array $options)
        {
            if (!isset($options['database']) || !isset($options['collection'])) {
                throw new \InvalidArgumentException('You must provide the "database" and "collection" option for MongoDBSessionHandler');
            }

            $this->mongo = $mongo;

            $this->options = array_merge(array(
                'id_field' => '_id',
                'data_field' => 'data',
                'time_field' => 'time',
                'expiry_field' => 'expires_at',
            ), $options);
        }

        /**
         * {@inheritdoc}
         */
        public function close()
        {
            return true;
        }

        /**
         * {@inheritdoc}
         */
        protected function doDestroy($sessionId)
        {
            $this->getCollection()->deleteOne(array(
                $this->options['id_field'] => $sessionId,
            ));

            return true;
        }

        /**
         * {@inheritdoc}
         */
        public function gc($maxlifetime)
        {
            $this->getCollection()->deleteMany(array(
                $this->options['expiry_field'] => array('$lt' => new \MongoDB\BSON\UTCDateTime()),
            ));

            return true;
        }

        /**
         * {@inheritdoc}
         */
        protected function doWrite($sessionId, $data)
        {
            $expiry = new \MongoDB\BSON\UTCDateTime((time() + (int) ini_get('session.gc_maxlifetime')) * 1000);

            $fields = array(
                $this->options['time_field'] => new \MongoDB\BSON\UTCDateTime(),
                $this->options['expiry_field'] => $expiry,
                $this->options['data_field'] => new \MongoDB\BSON\Binary($data, \MongoDB\BSON\Binary::TYPE_OLD_BINARY),
            );

            $this->getCollection()->updateOne(
                array($this->options['id_field'] => $sessionId),
                array('$set' => $fields),
                array('upsert' => true)
            );

            return true;
        }

        /**
         * {@inheritdoc}
         */
        public function updateTimestamp($sessionId, $data)
        {
            $expiry = new \MongoDB\BSON\UTCDateTime((time() + (int) ini_get('session.gc_maxlifetime')) * 1000);

            if ($this->mongo instanceof \MongoDB\Client) {
                $methodName = 'updateOne';
                $options = array();
            } else {
                $methodName = 'update';
                $options = array('multiple' => false);
            }

            $this->getCollection()->$methodName(
                array($this->options['id_field'] => $sessionId),
                array('$set' => array(
                    $this->options['time_field'] => new \MongoDB\BSON\UTCDateTime(),
                    $this->options['expiry_field'] => $expiry,
                )),
                $options
            );

            return true;
        }

        /**
         * {@inheritdoc}
         */
        protected function doRead($sessionId)
        {
            $dbData = $this->getCollection()->findOne(array(
                $this->options['id_field'] => $sessionId,
                $this->options['expiry_field'] => array('$gte' => new \MongoDB\BSON\UTCDateTime()),
            ));

            if (null === $dbData) {
                return '';
            }

            return $dbData[$this->options['data_field']]->getData();
        }

        /**
         * @return \MongoCollection
         */
        private function getCollection()
        {
            if (null === $this->collection) {
                $this->collection = $this->mongo->selectCollection($this->options['database'], $this->options['collection']);
            }

            return $this->collection;
        }

        /**
         * @return \MongoDB\Client
         */
        protected function getMongo()
        {
            return $this->mongo;
        }
    }