ExtMongoDbOptions
extends AdapterOptions
in package
Options for the ext-mongodb adapter implementation.
If you are using ext-mongo, use the MongoDbOptions class instead.
Table of Contents
- $__prioritizedProperties__ : array<string|int, string>
- Prioritized properties ordered by prio to be set first in case a bulk of options sets set at once
- $__strictMode__ : bool
- We use the __ prefix to avoid collisions with properties in user-implementations.
- $adapter : null|StorageInterface
- The adapter using these options
- $keyPattern : string
- Validate key against pattern
- $namespace : string
- Namespace option
- $readable : bool
- Readable option
- $ttl : int|float
- TTL option
- $writable : bool
- Writable option
- $namespaceSeparator : string
- The namespace separator
- $resourceId : string
- The resource id of the resource manager
- $resourceManager : null|ExtMongoDbResourceManager
- The ext-mongodb resource manager
- __construct() : mixed
- Constructor
- __get() : mixed
- Get a configuration property
- __isset() : bool
- Test if a configuration property is null
- __set() : void
- Set a configuration property
- __unset() : void
- Set a configuration property to NULL
- getKeyPattern() : string
- Get key pattern
- getNamespace() : string
- Get namespace
- getNamespaceSeparator() : string
- Get namespace separator
- getReadable() : bool
- If reading data from cache enabled.
- getResourceId() : string
- Get the ext-mongodb resource id
- getResourceManager() : ExtMongoDbResourceManager
- Get the ext-mongodb resource manager
- getTtl() : float
- Get time to live.
- getWritable() : bool
- If writing data to cache enabled.
- setAdapter() : AdapterOptions
- Adapter using this instance
- setCollection() : self
- setConnectionOptions() : self
- setDatabase() : string
- setDriverOptions() : self
- setFromArray() : AbstractOptions
- Set one or more configuration properties
- setKeyPattern() : AdapterOptions
- Set key pattern
- setNamespace() : AdapterOptions
- Set namespace.
- setNamespaceSeparator() : self
- Set namespace separator
- setReadable() : AdapterOptions
- Enable/Disable reading data from cache.
- setResourceId() : self
- Set the ext-mongodb resource id
- setResourceManager() : self
- Set the ext-mongodb resource manager to use
- setServer() : self
- Set the ext-mongodb server
- setTtl() : AdapterOptions
- Set time to live.
- setWritable() : AdapterOptions
- Enable/Disable writing data to cache.
- toArray() : array<string|int, mixed>
- Cast to array
- normalizeTtl() : void
- Validates and normalize a TTL.
- triggerOptionEvent() : void
- Triggers an option event if this options instance has a connection to an adapter implements EventsCapableInterface.
Properties
$__prioritizedProperties__
Prioritized properties ordered by prio to be set first in case a bulk of options sets set at once
protected
array<string|int, string>
$__prioritizedProperties__
= ['resource_manager', 'resource_id']
$__strictMode__
We use the __ prefix to avoid collisions with properties in user-implementations.
protected
bool
$__strictMode__
= true
$adapter
The adapter using these options
protected
null|StorageInterface
$adapter
$keyPattern
Validate key against pattern
protected
string
$keyPattern
= ''
$namespace
Namespace option
protected
string
$namespace
= 'zfcache'
$readable
Readable option
protected
bool
$readable
= true
$ttl
TTL option
protected
int|float
$ttl
= 0
0 means infinite or maximum of adapter
$writable
Writable option
protected
bool
$writable
= true
$namespaceSeparator
The namespace separator
private
string
$namespaceSeparator
= ':'
$resourceId
The resource id of the resource manager
private
string
$resourceId
= 'default'
$resourceManager
The ext-mongodb resource manager
private
null|ExtMongoDbResourceManager
$resourceManager
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed>|Traversable|null $options = null ]) : mixed
Parameters
- $options : array<string|int, mixed>|Traversable|null = null
Return values
mixed —__get()
Get a configuration property
public
__get(string $key) : mixed
Parameters
- $key : string
Tags
Return values
mixed —__isset()
Test if a configuration property is null
public
__isset(string $key) : bool
Parameters
- $key : string
Tags
Return values
bool —__set()
Set a configuration property
public
__set(string $key, mixed $value) : void
Parameters
- $key : string
- $value : mixed
Tags
Return values
void —__unset()
Set a configuration property to NULL
public
__unset(string $key) : void
Parameters
- $key : string
Tags
Return values
void —getKeyPattern()
Get key pattern
public
getKeyPattern() : string
Return values
string —getNamespace()
Get namespace
public
getNamespace() : string
Return values
string —getNamespaceSeparator()
Get namespace separator
public
getNamespaceSeparator() : string
Return values
string —getReadable()
If reading data from cache enabled.
public
getReadable() : bool
Return values
bool —getResourceId()
Get the ext-mongodb resource id
public
getResourceId() : string
Return values
string —getResourceManager()
Get the ext-mongodb resource manager
public
getResourceManager() : ExtMongoDbResourceManager
Return values
ExtMongoDbResourceManager —getTtl()
Get time to live.
public
getTtl() : float
Return values
float —getWritable()
If writing data to cache enabled.
public
getWritable() : bool
Return values
bool —setAdapter()
Adapter using this instance
public
setAdapter([StorageInterface|null $adapter = null ]) : AdapterOptions
Parameters
- $adapter : StorageInterface|null = null
Return values
AdapterOptions —Provides a fluent interface
setCollection()
public
setCollection(string $collection) : self
Parameters
- $collection : string
Return values
self —Provides a fluent interface
setConnectionOptions()
public
setConnectionOptions(array<string|int, mixed> $connectionOptions) : self
Parameters
- $connectionOptions : array<string|int, mixed>
Return values
self —Provides a fluent interface
setDatabase()
public
setDatabase(string $database) : string
Parameters
- $database : string
Return values
string —Provides a fluent interface
setDriverOptions()
public
setDriverOptions(array<string|int, mixed> $driverOptions) : self
Parameters
- $driverOptions : array<string|int, mixed>
-
ext-mongodb driver options
Return values
self —Provides a fluent interface
setFromArray()
Set one or more configuration properties
public
setFromArray(array<string|int, mixed>|Traversable|AbstractOptions $options) : AbstractOptions
Parameters
- $options : array<string|int, mixed>|Traversable|AbstractOptions
Tags
Return values
AbstractOptions —Provides fluent interface
setKeyPattern()
Set key pattern
public
setKeyPattern(string $keyPattern) : AdapterOptions
Parameters
- $keyPattern : string
Tags
Return values
AdapterOptions —Provides a fluent interface
setNamespace()
Set namespace.
public
setNamespace(string $namespace) : AdapterOptions
Parameters
- $namespace : string
Return values
AdapterOptions —Provides a fluent interface
setNamespaceSeparator()
Set namespace separator
public
setNamespaceSeparator(string $namespaceSeparator) : self
Parameters
- $namespaceSeparator : string
Return values
self —Provides a fluent interface
setReadable()
Enable/Disable reading data from cache.
public
setReadable(bool $readable) : AdapterOptions
Parameters
- $readable : bool
Return values
AdapterOptions —Provides a fluent interface
setResourceId()
Set the ext-mongodb resource id
public
setResourceId(string $resourceId) : self
Parameters
- $resourceId : string
Return values
self —Provides a fluent interface
setResourceManager()
Set the ext-mongodb resource manager to use
public
setResourceManager([null|ExtMongoDbResourceManager $resourceManager = null ]) : self
Parameters
- $resourceManager : null|ExtMongoDbResourceManager = null
Return values
self —Provides a fluent interface
setServer()
Set the ext-mongodb server
public
setServer(string $server) : self
Parameters
- $server : string
Return values
self —Provides a fluent interface
setTtl()
Set time to live.
public
setTtl(int|float $ttl) : AdapterOptions
Parameters
- $ttl : int|float
Return values
AdapterOptions —Provides a fluent interface
setWritable()
Enable/Disable writing data to cache.
public
setWritable(bool $writable) : AdapterOptions
Parameters
- $writable : bool
Return values
AdapterOptions —Provides a fluent interface
toArray()
Cast to array
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —normalizeTtl()
Validates and normalize a TTL.
protected
normalizeTtl(int|float &$ttl) : void
Parameters
- $ttl : int|float
Tags
Return values
void —triggerOptionEvent()
Triggers an option event if this options instance has a connection to an adapter implements EventsCapableInterface.
protected
triggerOptionEvent(string $optionName, mixed $optionValue) : void
Parameters
- $optionName : string
- $optionValue : mixed