Class yii\mongodb\Session
| Inheritance | yii\mongodb\Session » yii\web\MultiFieldSession |
|---|---|
| Available since version | 2.0 |
Session extends \yii\web\Session by using MongoDB as session data storage.
By default, Session stores session data in a collection named 'session' inside the default database. This collection is better to be pre-created with fields 'id' and 'expire' indexed. The collection name can be changed by setting $sessionCollection.
The following example shows how you can configure the application to use Session:
Add the following to your application config under components:
'session' => [
'class' => 'yii\mongodb\Session',
// 'db' => 'mymongodb',
// 'sessionCollection' => 'my_session',
]
Session extends \yii\web\MultiFieldSession, thus it allows saving extra fields into the $sessionCollection. Refer to \yii\web\MultiFieldSession for more details.
Tip: you can use MongoDB TTL index for the session garbage
collection for performance saving, in this case you should set yii\mongodb\Session::gCProbability to 0.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $db | yii\mongodb\Connection|array|string | The MongoDB connection object or the application component ID of the MongoDB connection. | yii\mongodb\Session |
| $sessionCollection | string|array | The name of the MongoDB collection that stores the session data. | yii\mongodb\Session |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| destroySession() | Session destroy handler. | yii\mongodb\Session |
| gcSession() | Session GC (garbage collection) handler. | yii\mongodb\Session |
| init() | Initializes the Session component. | yii\mongodb\Session |
| readSession() | Session read handler. | yii\mongodb\Session |
| regenerateID() | Updates the current session ID with a newly generated one. | yii\mongodb\Session |
| writeSession() | Session write handler. | yii\mongodb\Session |
Property Details
The MongoDB connection object or the application component ID of the MongoDB connection. After the Session object is created, if you want to change this property, you should only assign it with a MongoDB connection object. Starting from version 2.0.2, this can also be a configuration array for creating the object.
The name of the MongoDB collection that stores the session data. Please refer to yii\mongodb\Connection::getCollection() on how to specify this parameter. This collection is better to be pre-created with fields 'id' and 'expire' indexed.
Method Details
Session destroy handler.
Do not call this method directly.
| public boolean destroySession ( $id ) | ||
| $id | string | Session ID |
| return | boolean | Whether session is destroyed successfully |
|---|---|---|
Session GC (garbage collection) handler.
Do not call this method directly.
| public boolean gcSession ( $maxLifetime ) | ||
| $maxLifetime | integer | The number of seconds after which data will be seen as 'garbage' and cleaned up. |
| return | boolean | Whether session is GCed successfully |
|---|---|---|
Initializes the Session component.
This method will initialize the $db property to make sure it refers to a valid MongoDB connection.
| public void init ( ) | ||
| throws | \yii\base\InvalidConfigException | if $db is invalid. |
|---|---|---|
Session read handler.
Do not call this method directly.
| public string readSession ( $id ) | ||
| $id | string | Session ID |
| return | string | The session data |
|---|---|---|
Updates the current session ID with a newly generated one.
Please refer to http://php.net/session_regenerate_id for more details.
| public void regenerateID ( $deleteOldSession = false ) | ||
| $deleteOldSession | boolean | Whether to delete the old associated session file or not. |
Session write handler.
Do not call this method directly.
| public boolean writeSession ( $id, $data ) | ||
| $id | string | Session ID |
| $data | string | Session data |
| return | boolean | Whether session write is successful |
|---|---|---|