Fully Qualified Name: | Zend\Cache\Storage\Adapter\ExtMongoDbOptions |
Extends: | AdapterOptions |
Options for the ext-mongodb adapter implementation.
If you are using ext-mongo, use the MongoDbOptions class instead.
Constructor
Parameter Name | Type | Description |
---|---|---|
$options | array|\Traversable|null |
Returns:
Get a configuration property
Parameter Name | Type | Description |
---|---|---|
$key | string |
Returns: mixed
Test if a configuration property is null
Parameter Name | Type | Description |
---|---|---|
$key | string |
Returns: bool
Set a configuration property
Parameter Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
Returns: void
Set a configuration property to NULL
Parameter Name | Type | Description |
---|---|---|
$key | string |
Returns: void
Get key pattern
Returns: string
Get namespace
Returns: string
Get namespace separator
Returns: string
If reading data from cache enabled.
Returns: bool
Get the ext-mongodb resource id
Returns: string
Get the ext-mongodb resource manager
Returns: \ExtMongoDbResourceManager
Get time to live.
Returns: float
If writing data to cache enabled.
Returns: bool
Adapter using this instance
Parameter Name | Type | Description |
---|---|---|
$adapter | \StorageInterface|null |
Returns: \AdapterOptions Provides a fluent interface
Parameter Name | Type | Description |
---|---|---|
$collection | string |
Returns: self Provides a fluent interface
Parameter Name | Type | Description |
---|---|---|
$connectionOptions | array |
Returns: self Provides a fluent interface
Parameter Name | Type | Description |
---|---|---|
$database | string |
Returns: string Provides a fluent interface
Parameter Name | Type | Description |
---|---|---|
$driverOptions | array | ext-mongodb |
Returns: self Provides a fluent interface
{@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
Set key pattern
Parameter Name | Type | Description |
---|---|---|
$keyPattern | string |
Returns: \AdapterOptions Provides a fluent interface
Set namespace.
Parameter Name | Type | Description |
---|---|---|
$namespace | string |
Returns: \AdapterOptions Provides a fluent interface
Set namespace separator
Parameter Name | Type | Description |
---|---|---|
$namespaceSeparator | string |
Returns: self Provides a fluent interface
Enable/Disable reading data from cache.
Parameter Name | Type | Description |
---|---|---|
$readable | bool |
Returns: \AdapterOptions Provides a fluent interface
Set the ext-mongodb resource id
Parameter Name | Type | Description |
---|---|---|
$resourceId | string |
Returns: self Provides a fluent interface
Set the ext-mongodb resource manager to use
Parameter Name | Type | Description |
---|---|---|
$resourceManager | null|\ExtMongoDbResourceManager |
Returns: self Provides a fluent interface
Set the ext-mongodb server
Parameter Name | Type | Description |
---|---|---|
$server | string |
Returns: self Provides a fluent interface
Set time to live.
Parameter Name | Type | Description |
---|---|---|
$ttl | int|float |
Returns: \AdapterOptions Provides a fluent interface
Enable/Disable writing data to cache.
Parameter Name | Type | Description |
---|---|---|
$writable | bool |
Returns: \AdapterOptions Provides a fluent interface
Cast to array
Returns: array