XCacheOptions
extends AdapterOptions
in package
These are options specific to the XCache adapter
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
- $adminAuth : bool
- Handle admin authentication
- $adminPass : null|string
- Password to call admin functions
- $adminUser : null|string
- Username to call admin functions
- $keyPattern : string
- Validate key against pattern
- $namespace : string
- Namespace option
- $namespaceSeparator : string
- Namespace separator
- $readable : bool
- Readable option
- $ttl : int|float
- TTL option
- $writable : bool
- Writable option
- __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
- getAdminAuth() : bool
- Get admin authentication enabled
- getAdminPass() : string
- Get password to call admin functions
- getAdminUser() : string
- Get username to call admin functions
- getKeyPattern() : string
- Get key pattern
- getNamespace() : string
- Get namespace
- getNamespaceSeparator() : string
- Get namespace separator
- getReadable() : bool
- If reading data from cache enabled.
- getTtl() : float
- Get time to live.
- getWritable() : bool
- If writing data to cache enabled.
- setAdapter() : AdapterOptions
- Adapter using this instance
- setAdminAuth() : XCacheOptions
- Enable/Disable admin authentication handling
- setAdminPass() : XCacheOptions
- Set password to call admin functions
- setAdminUser() : XCacheOptions
- Set username to call admin functions
- setFromArray() : AbstractOptions
- Set one or more configuration properties
- setKeyPattern() : AdapterOptions
- Set key pattern
- setNamespace() : AdapterOptions
- Set namespace.
- setNamespaceSeparator() : XCacheOptions
- Set namespace separator
- setReadable() : AdapterOptions
- Enable/Disable reading data from cache.
- 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__
= []
$__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
$adminAuth
Handle admin authentication
protected
bool
$adminAuth
= false
$adminPass
Password to call admin functions
protected
null|string
$adminPass
$adminUser
Username to call admin functions
protected
null|string
$adminUser
$keyPattern
Validate key against pattern
protected
string
$keyPattern
= ''
$namespace
Namespace option
protected
string
$namespace
= 'zfcache'
$namespaceSeparator
Namespace separator
protected
string
$namespaceSeparator
= ':'
$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
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 —getAdminAuth()
Get admin authentication enabled
public
getAdminAuth() : bool
Return values
bool —getAdminPass()
Get password to call admin functions
public
getAdminPass() : string
Return values
string —getAdminUser()
Get username to call admin functions
public
getAdminUser() : string
Return values
string —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 —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
setAdminAuth()
Enable/Disable admin authentication handling
public
setAdminAuth(bool $adminAuth) : XCacheOptions
Parameters
- $adminAuth : bool
Return values
XCacheOptions —Provides a fluent interface
setAdminPass()
Set password to call admin functions
public
setAdminPass(null|string $adminPass) : XCacheOptions
Parameters
- $adminPass : null|string
Return values
XCacheOptions —Provides a fluent interface
setAdminUser()
Set username to call admin functions
public
setAdminUser(null|string $adminUser) : XCacheOptions
Parameters
- $adminUser : null|string
Return values
XCacheOptions —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) : XCacheOptions
Parameters
- $namespaceSeparator : string
Return values
XCacheOptions —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
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