Class ExtMongoDbOptions

Summary

Fully Qualified Name: Zend\Cache\Storage\Adapter\ExtMongoDbOptions
Extends: AdapterOptions

Description

Options for the ext-mongodb adapter implementation.

If you are using ext-mongo, use the MongoDbOptions class instead.

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 ExtMongoDbOptions
getReadable() If reading data from cache enabled. AdapterOptions
getResourceId() Get the ext-mongodb resource id ExtMongoDbOptions
getResourceManager() Get the ext-mongodb resource manager ExtMongoDbOptions
getTtl() Get time to live. AdapterOptions
getWritable() If writing data to cache enabled. AdapterOptions
setAdapter() Adapter using this instance AdapterOptions
setCollection() ExtMongoDbOptions
setConnectionOptions() ExtMongoDbOptions
setDatabase() ExtMongoDbOptions
setDriverOptions() ExtMongoDbOptions
setFromArray() {@inheritdoc} AdapterOptions
setKeyPattern() Set key pattern AdapterOptions
setNamespace() Set namespace. AdapterOptions
setNamespaceSeparator() Set namespace separator ExtMongoDbOptions
setReadable() Enable/Disable reading data from cache. AdapterOptions
setResourceId() Set the ext-mongodb resource id ExtMongoDbOptions
setResourceManager() Set the ext-mongodb resource manager to use ExtMongoDbOptions
setServer() Set the ext-mongodb server ExtMongoDbOptions
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 ext-mongodb resource id

Returns: string

getResourceManager()

Get the ext-mongodb resource manager

Returns: \ExtMongoDbResourceManager

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: self Provides a fluent interface

setConnectionOptions()

Parameter Name Type Description
$connectionOptions array

Returns: self Provides a fluent interface

setDatabase()

Parameter Name Type Description
$database string

Returns: string Provides a fluent interface

setDriverOptions()

Parameter Name Type Description
$driverOptions array ext-mongodb

Returns: self 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: self 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 ext-mongodb resource id

Parameter Name Type Description
$resourceId string

Returns: self Provides a fluent interface

setResourceManager()

Set the ext-mongodb resource manager to use

Parameter Name Type Description
$resourceManager null|\ExtMongoDbResourceManager

Returns: self Provides a fluent interface

setServer()

Set the ext-mongodb server

Parameter Name Type Description
$server string

Returns: self 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

Top