Summary

Fully Qualified Name:	Laminas\Cache\Storage\Adapter\MongoDbOptions
Extends:	AdapterOptions

Description

Methods

Name	Description	Defined By
__construct()	Constructor	AbstractOptions
__get()	Get a configuration property	AbstractOptions
__isset()	Test if a configuration property is null	AbstractOptions
__set()	Set a configuration property	AbstractOptions
__unset()	Set a configuration property to NULL	AbstractOptions
getKeyPattern()	Get key pattern	AdapterOptions
getNamespace()	Get namespace	AdapterOptions
getNamespaceSeparator()	Get namespace separator	MongoDbOptions
getReadable()	If reading data from cache enabled.	AdapterOptions
getResourceId()	Get the mongodb resource id	MongoDbOptions
getResourceManager()	Get the mongodb resource manager	MongoDbOptions
getTtl()	Get time to live.	AdapterOptions
getWritable()	If writing data to cache enabled.	AdapterOptions
setAdapter()	Adapter using this instance	AdapterOptions
setCollection()		MongoDbOptions
setConnectionOptions()		MongoDbOptions
setDatabase()		MongoDbOptions
setDriverOptions()		MongoDbOptions
setFromArray()	{@inheritdoc}	AdapterOptions
setKeyPattern()	Set key pattern	AdapterOptions
setNamespace()	Set namespace.	AdapterOptions
setNamespaceSeparator()	Set namespace separator	MongoDbOptions
setReadable()	Enable/Disable reading data from cache.	AdapterOptions
setResourceId()	Set the mongodb resource id	MongoDbOptions
setResourceManager()	Set the mongodb resource manager to use	MongoDbOptions
setServer()	Set the mongo DB server	MongoDbOptions
setTtl()	Set time to live.	AdapterOptions
setWritable()	Enable/Disable writing data to cache.	AdapterOptions
toArray()	Cast to array	AdapterOptions

Method Details

__construct()

Constructor

Parameter Name	Type	Description
$options	array|\Traversable|null

Returns:

__get()

Get a configuration property

Parameter Name	Type	Description
$key	string

Returns: mixed

__isset()

Test if a configuration property is null

Parameter Name	Type	Description
$key	string

Returns: bool

__set()

Set a configuration property

Parameter Name	Type	Description
$key	string
$value	mixed

Returns: void

__unset()

Set a configuration property to NULL

Parameter Name	Type	Description
$key	string

Returns: void

getKeyPattern()

Get key pattern

Returns: string

getNamespace()

Get namespace

Returns: string

getNamespaceSeparator()

Get namespace separator

Returns: string

getReadable()

If reading data from cache enabled.

Returns: bool

getResourceId()

Get the mongodb resource id

Returns: string

getResourceManager()

Get the mongodb resource manager

Returns: \MongoDbResourceManager

getTtl()

Get time to live.

Returns: float

getWritable()

If writing data to cache enabled.

Returns: bool

setAdapter()

Adapter using this instance

Parameter Name	Type	Description
$adapter	\StorageInterface|null

Returns: \AdapterOptions Provides a fluent interface

setCollection()

Parameter Name	Type	Description
$collection	string

Returns: \MongoDbOptions Provides a fluent interface

setConnectionOptions()

Parameter Name	Type	Description
$connectionOptions	array

Returns: \MongoDbOptions Provides a fluent interface

setDatabase()

Parameter Name	Type	Description
$database	string

Returns: \MongoDbOptions Provides a fluent interface

setDriverOptions()

Parameter Name	Type	Description
$driverOptions	array	MongoDbOptions

Returns: \MongoDbOptions Provides a fluent interface

setFromArray()

{@inheritdoc}

NOTE: This method was overwritten just to support prioritized properties {@link https://github.com/zendframework/zf2/issues/6381}

Parameter Name	Type	Description
$options	array|\Traversable|\AbstractOptions

Returns: \AbstractOptions Provides fluent interface

setKeyPattern()

Set key pattern

Parameter Name	Type	Description
$keyPattern	string

Returns: \AdapterOptions Provides a fluent interface

setNamespace()

Set namespace.

Parameter Name	Type	Description
$namespace	string

Returns: \AdapterOptions Provides a fluent interface

setNamespaceSeparator()

Set namespace separator

Parameter Name	Type	Description
$namespaceSeparator	string

Returns: \MongoDbOptions Provides a fluent interface

setReadable()

Enable/Disable reading data from cache.

Parameter Name	Type	Description
$readable	bool

Returns: \AdapterOptions Provides a fluent interface

setResourceId()

Set the mongodb resource id

Parameter Name	Type	Description
$resourceId	string

Returns: \MongoDbOptions Provides a fluent interface

setResourceManager()

Set the mongodb resource manager to use

Parameter Name	Type	Description
$resourceManager	null|\MongoDbResourceManager

Returns: \MongoDbOptions Provides a fluent interface

setServer()

Set the mongo DB server

Parameter Name	Type	Description
$server	string

Returns: \MongoDbOptions Provides a fluent interface

setTtl()

Set time to live.

Parameter Name	Type	Description
$ttl	int|float

Returns: \AdapterOptions Provides a fluent interface

setWritable()

Enable/Disable writing data to cache.

Parameter Name	Type	Description
$writable	bool

Returns: \AdapterOptions Provides a fluent interface

toArray()

Cast to array

Returns: array