FileAccess Orion

MongoDbOptions extends AdapterOptions
in package

Unless otherwise marked, all options in this class affect all adapters.

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|MongoDbResourceManager
The mongo DB 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 mongodb resource id
getResourceManager()  : MongoDbResourceManager
Get the mongodb resource manager
getTtl()  : float
Get time to live.
getWritable()  : bool
If writing data to cache enabled.
setAdapter()  : AdapterOptions
Adapter using this instance
setCollection()  : MongoDbOptions
setConnectionOptions()  : MongoDbOptions
setDatabase()  : MongoDbOptions
setDriverOptions()  : MongoDbOptions
setFromArray()  : AbstractOptions
Set one or more configuration properties
setKeyPattern()  : AdapterOptions
Set key pattern
setNamespace()  : AdapterOptions
Set namespace.
setNamespaceSeparator()  : MongoDbOptions
Set namespace separator
setReadable()  : AdapterOptions
Enable/Disable reading data from cache.
setResourceId()  : MongoDbOptions
Set the mongodb resource id
setResourceManager()  : MongoDbOptions
Set the mongodb resource manager to use
setServer()  : MongoDbOptions
Set the mongo DB 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

$keyPattern

Validate key against pattern

protected string $keyPattern = ''

$namespace

Namespace option

protected string $namespace = 'zfcache'

$ttl

TTL option

protected int|float $ttl = 0

0 means infinite or maximum of adapter

$namespaceSeparator

The namespace separator

private string $namespaceSeparator = ':'

$resourceId

The resource id of the resource manager

private string $resourceId = 'default'

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
see
ParameterObject::__get()
throws
BadMethodCallException
Return values
mixed —

__isset()

Test if a configuration property is null

public __isset(string $key) : bool
Parameters
$key : string
Tags
see
ParameterObject::__isset()
Return values
bool —

__set()

Set a configuration property

public __set(string $key, mixed $value) : void
Parameters
$key : string
$value : mixed
Tags
see
ParameterObject::__set()
throws
BadMethodCallException
Return values
void —

__unset()

Set a configuration property to NULL

public __unset(string $key) : void
Parameters
$key : string
Tags
see
ParameterObject::__unset()
throws
InvalidArgumentException
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 mongodb resource id

public getResourceId() : string
Return values
string —

getTtl()

Get time to live.

public getTtl() : float
Return values
float —

getWritable()

If writing data to cache enabled.

public getWritable() : bool
Return values
bool —

setConnectionOptions()

public setConnectionOptions(array<string|int, mixed> $connectionOptions) : MongoDbOptions
Parameters
$connectionOptions : array<string|int, mixed>
Return values
MongoDbOptions —

Provides a fluent interface

setDriverOptions()

public setDriverOptions(array<string|int, mixed> $driverOptions) : MongoDbOptions
Parameters
$driverOptions : array<string|int, mixed>

MongoDbOptions

Return values
MongoDbOptions —

Provides a fluent interface

setNamespaceSeparator()

Set namespace separator

public setNamespaceSeparator(string $namespaceSeparator) : MongoDbOptions
Parameters
$namespaceSeparator : string
Return values
MongoDbOptions —

Provides a fluent interface

toArray()

Cast to array

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —

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
Return values
void —

Search results