Zend Framework » \Zend\Session\SaveHandler\MongoDBOptions

MongoDB session save handler Options

Methods

Constructor

__construct(array | \Traversable | null $options)

Parameters

$options

array\Traversablenull

Get a configuration property

__get(string $key) : mixed

Inherited

see	\Zend\Stdlib\ParameterObject::__get()
inherited_from	\Zend\Stdlib\AbstractOptions::__get()

Parameters

$key

string

Exceptions

`\Zend\Stdlib\Exception\BadMethodCallException`

Returns

mixed

Test if a configuration property is null

__isset(string $key) : bool

Inherited

see	\Zend\Stdlib\ParameterObject::__isset()
inherited_from	\Zend\Stdlib\AbstractOptions::__isset()

Parameters

$key

string

Returns

bool

Override AbstractOptions::__set

__set(string $key, mixed $value) : void

Validates value if save options are being set.

Parameters

$key

string

$value

mixed

Exceptions

`\Zend\Stdlib\Exception\BadMethodCallException`

Set a configuration property to NULL

__unset(string $key) : void

Inherited

see	\Zend\Stdlib\ParameterObject::__unset()
inherited_from	\Zend\Stdlib\AbstractOptions::__unset()

Parameters

$key

string

Exceptions

`\Zend\Stdlib\Exception\InvalidArgumentException`

Get collection name

getCollection() : string

Returns

string

Get data field

getDataField() : string

Returns

string

Get database name

getDatabase() : string

Returns

string

Get lifetime Field

getLifetimeField() : string

Returns

string

Get modified Field

getModifiedField() : string

Returns

string

Get name field

getNameField() : string

Returns

string

Get save options

getSaveOptions() : string

Returns

string

Set collection name

setCollection(string $collection) : \Zend\Session\SaveHandler\MongoDBOptions

Parameters

$collection

string

Exceptions

`\Zend\Session\Exception\InvalidArgumentException`

Returns

\Zend\Session\SaveHandler\MongoDBOptions

Set data field

setDataField(string $dataField) : \Zend\Session\SaveHandler\MongoDBOptions

Parameters

$dataField

string

Exceptions

`\Zend\Session\Exception\InvalidArgumentException`

Returns

\Zend\Session\SaveHandler\MongoDBOptions

Set database name

setDatabase(string $database) : \Zend\Session\SaveHandler\MongoDBOptions

Parameters

$database

string

Exceptions

`\Zend\Session\Exception\InvalidArgumentException`

Returns

\Zend\Session\SaveHandler\MongoDBOptions

Set one or more configuration properties

setFromArray(array | \Traversable | \Zend\Stdlib\AbstractOptions $options) : \Zend\Stdlib\AbstractOptions

Inherited

inherited_from	\Zend\Stdlib\AbstractOptions::setFromArray()

Parameters

$options

array\Traversable\Zend\Stdlib\AbstractOptions

Exceptions

`\Zend\Stdlib\Exception\InvalidArgumentException`

Returns

\Zend\Stdlib\AbstractOptionsProvides fluent interface

Set lifetime field

setLifetimeField(string $lifetimeField) : \Zend\Session\SaveHandler\MongoDBOptions

Parameters

$lifetimeField

string

Exceptions

`\Zend\Session\Exception\InvalidArgumentException`

Returns

\Zend\Session\SaveHandler\MongoDBOptions

Set Modified Field

setModifiedField(string $modifiedField) : \Zend\Session\SaveHandler\MongoDBOptions

Parameters

$modifiedField

string

Exceptions

`\Zend\Session\Exception\InvalidArgumentException`

Returns

\Zend\Session\SaveHandler\MongoDBOptions

Set name field

setNameField(string $nameField) : \Zend\Session\SaveHandler\MongoDBOptions

Parameters

$nameField

string

Exceptions

`\Zend\Session\Exception\InvalidArgumentException`

Returns

\Zend\Session\SaveHandler\MongoDBOptions

Set save options

setSaveOptions(array $saveOptions) : \Zend\Session\SaveHandler\MongoDBOptions

see	\Zend\Session\SaveHandler\http://php.net/manual/en/mongocollection.save.php

Parameters

$saveOptions

array

Returns

\Zend\Session\SaveHandler\MongoDBOptions

Cast to array

toArray() : array

Inherited

inherited_from	\Zend\Stdlib\AbstractOptions::toArray()

Returns

array

Properties

We use the __ prefix to avoid collisions with properties in user-implementations.

$__strictMode__ : bool

Inherited

inherited_from	\Zend\Stdlib\AbstractOptions::$$__strictMode__

Collection name

$collection : string

Data field

$dataField : string

Database name

$database : string

Lifetime field

$lifetimeField : string

Modified field

$modifiedField : string

Name field

$nameField : string

Save options

$saveOptions : string

see	\Zend\Session\SaveHandler\http://php.net/manual/en/mongocollection.save.php