FileAccess Orion

RedisOptions 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
$namespaceSeparator  : string
The namespace separator
$readable  : bool
Readable option
$resourceId  : string
The resource id of the resource manager
$resourceManager  : null|RedisResourceManager
The redis resource manager
$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
getDatabase()  : int
Get resource database number
getKeyPattern()  : string
Get key pattern
getLibOptions()  : array<string|int, mixed>
Get redis options
getNamespace()  : string
Get namespace
getNamespaceSeparator()  : string
Get namespace separator
getPassword()  : string
Get resource password
getPersistentId()  : string
Get the persistent id
getReadable()  : bool
If reading data from cache enabled.
getResourceId()  : string
Get the redis resource id
getResourceManager()  : RedisResourceManager
Get the redis resource manager
getServer()  : array<string|int, mixed>
Get server
getTtl()  : float
Get time to live.
getWritable()  : bool
If writing data to cache enabled.
setAdapter()  : AdapterOptions
Adapter using this instance
setDatabase()  : RedisOptions
Set resource database number
setFromArray()  : AbstractOptions
Set one or more configuration properties
setKeyPattern()  : AdapterOptions
Set key pattern
setLibOptions()  : RedisOptions
Set redis options
setNamespace()  : RedisOptions
Set namespace.
setNamespaceSeparator()  : RedisOptions
Set namespace separator
setPassword()  : RedisOptions
Set resource password
setPersistentId()  : RedisOptions
Set the persistent id
setReadable()  : AdapterOptions
Enable/Disable reading data from cache.
setResourceId()  : RedisOptions
Set the redis resource id
setResourceManager()  : RedisOptions
Set the redis resource manager to use
setServer()  : RedisOptions
Set 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', 'server']

$__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'

$namespaceSeparator

The namespace separator

protected string $namespaceSeparator = ':'

$resourceId

The resource id of the resource manager

protected string $resourceId = 'default'

$ttl

TTL option

protected int|float $ttl = 0

0 means infinite or maximum of adapter

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 —

getDatabase()

Get resource database number

public getDatabase() : int
Return values
int —

Database number

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 —

getPassword()

Get resource password

public getPassword() : string
Return values
string —

getPersistentId()

Get the persistent id

public getPersistentId() : string
Return values
string —

getReadable()

If reading data from cache enabled.

public getReadable() : bool
Return values
bool —

getResourceId()

Get the redis resource id

public getResourceId() : string
Return values
string —

getServer()

Get server

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

array('host' => [, 'port' => [, 'timeout' => ]])

getTtl()

Get time to live.

public getTtl() : float
Return values
float —

getWritable()

If writing data to cache enabled.

public getWritable() : bool
Return values
bool —

setDatabase()

Set resource database number

public setDatabase(int $database) : RedisOptions
Parameters
$database : int

Database number

Return values
RedisOptions —

Provides a fluent interface

setNamespace()

Set namespace.

public setNamespace(string $namespace) : RedisOptions

The option Redis::OPT_PREFIX will be used as the namespace. It can't be longer than 128 characters.

Parameters
$namespace : string

Prefix for each key stored in redis

Tags
see
AdapterOptions::setNamespace()
see
RedisOptions::setPrefixKey()
Return values
RedisOptions —

setNamespaceSeparator()

Set namespace separator

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

Provides a fluent interface

setPassword()

Set resource password

public setPassword(string $password) : RedisOptions
Parameters
$password : string

Password

Return values
RedisOptions —

Provides a fluent interface

setPersistentId()

Set the persistent id

public setPersistentId(string $persistentId) : RedisOptions
Parameters
$persistentId : string
Return values
RedisOptions —

Provides a fluent interface

setResourceId()

Set the redis resource id

public setResourceId(string $resourceId) : RedisOptions
Parameters
$resourceId : string
Return values
RedisOptions —

Provides a fluent interface

setServer()

Set server

public setServer(string|array<string|int, mixed> $server) : RedisOptions

Server can be described as follows:

  • URI: /path/to/sock.sock
  • Assoc: array('host' => [, 'port' => [, 'timeout' => ]])
  • List: array([, , [, ]])
Parameters
$server : string|array<string|int, mixed>
Return values
RedisOptions —

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