Zend Framework » \Zend\Cache\Storage\Adapter\RedisOptions

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

Methods

Constructor

__construct(array | \Traversable | null $options)

Inherited

inherited_from	\Zend\Stdlib\AbstractOptions::__construct()
inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::__construct()

Parameters

$options

array\Traversablenull

Get a configuration property

__get(string $key) : mixed

Inherited

see	\Zend\Stdlib\ParameterObject::__get()
inherited_from	\Zend\Stdlib\AbstractOptions::__get()
inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::__get()

Parameters

$key

string

Exceptions

`\Zend\Stdlib\Exception\BadMethodCallException`

Returns

mixed

Test if a configuration property is null

__isset(string $key) : bool

Inherited

see	\Zend\Stdlib\ParameterObject::__isset()
inherited_from	\Zend\Stdlib\AbstractOptions::__isset()
inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::__isset()

Parameters

$key

string

Returns

bool

Set a configuration property

__set(string $key, mixed $value) : void

Inherited

see	\Zend\Stdlib\ParameterObject::__set()
inherited_from	\Zend\Stdlib\AbstractOptions::__set()
inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::__set()

Parameters

$key

string

$value

mixed

Exceptions

`\Zend\Stdlib\Exception\BadMethodCallException`

Set a configuration property to NULL

__unset(string $key) : void

Inherited

see	\Zend\Stdlib\ParameterObject::__unset()
inherited_from	\Zend\Stdlib\AbstractOptions::__unset()
inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::__unset()

Parameters

$key

string

Exceptions

`\Zend\Stdlib\Exception\InvalidArgumentException`

Get resource database number

getDatabase() : int

Returns

intDatabase number

Get key pattern

getKeyPattern() : string

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::getKeyPattern()

Returns

string

Get redis options

getLibOptions() : array

link	http://github.com/nicolasff/phpredis#setoption

Returns

array

Get namespace

getNamespace() : string

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::getNamespace()

Returns

string

Get namespace separator

getNamespaceSeparator() : string

Returns

string

Get resource password

getPassword() : string

Returns

string

Get the persistent id

getPersistentId() : string

Returns

string

If reading data from cache enabled.

getReadable() : bool

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::getReadable()

Returns

bool

Get the redis resource id

getResourceId() : string

Returns

string

Get the redis resource manager

getResourceManager() : \Zend\Cache\Storage\Adapter\RedisResourceManager

Returns

\Zend\Cache\Storage\Adapter\RedisResourceManager

Get server

getServer() : array

Returns

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

Get time to live.

getTtl() : float

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::getTtl()

Returns

float

If writing data to cache enabled.

getWritable() : bool

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::getWritable()

Returns

bool

Adapter using this instance

setAdapter(\Zend\Cache\Storage\StorageInterface $adapter) : \Zend\Cache\Storage\Adapter\AdapterOptions

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::setAdapter()

Parameters

$adapter

\Zend\Cache\Storage\StorageInterfacenull

Returns

\Zend\Cache\Storage\Adapter\AdapterOptions

Set resource database number

setDatabase(int $database) : \Zend\Cache\Storage\Adapter\RedisOptions

Parameters

$database

int

Database number

Returns

\Zend\Cache\Storage\Adapter\RedisOptions

Set one or more configuration properties

setFromArray(array | \Traversable | \Zend\Stdlib\AbstractOptions $options) : \Zend\Stdlib\AbstractOptions

Inherited

inherited_from	\Zend\Stdlib\AbstractOptions::setFromArray()
inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::setFromArray()

Parameters

$options

array\Traversable\Zend\Stdlib\AbstractOptions

Exceptions

`\Zend\Stdlib\Exception\InvalidArgumentException`

Returns

\Zend\Stdlib\AbstractOptionsProvides fluent interface

Set key pattern

setKeyPattern(null | string $keyPattern) : \Zend\Cache\Storage\Adapter\AdapterOptions

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::setKeyPattern()

Parameters

$keyPattern

nullstring

Exceptions

`\Zend\Cache\Exception\InvalidArgumentException`

Returns

\Zend\Cache\Storage\Adapter\AdapterOptions

Set redis options

setLibOptions(array $libOptions) : \Zend\Cache\Storage\Adapter\RedisOptions

link	http://github.com/nicolasff/phpredis#setoption

Parameters

$libOptions

array

Returns

\Zend\Cache\Storage\Adapter\RedisOptions

Set namespace.

setNamespace(string $namespace) : \Zend\Cache\Storage\Adapter\RedisOptions

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

see	\Zend\Cache\Storage\Adapter\AdapterOptions::setNamespace()
see	\Zend\Cache\Storage\Adapter\RedisOptions::setPrefixKey()

Parameters

$namespace

string

Prefix for each key stored in redis

Returns

\Zend\Cache\Storage\Adapter\RedisOptions

Set namespace separator

setNamespaceSeparator(string $namespaceSeparator) : \Zend\Cache\Storage\Adapter\RedisOptions

Parameters

$namespaceSeparator

string

Returns

\Zend\Cache\Storage\Adapter\RedisOptions

Set resource password

setPassword(string $password) : \Zend\Cache\Storage\Adapter\RedisOptions

Parameters

$password

string

Password

Returns

\Zend\Cache\Storage\Adapter\RedisOptions

Set the persistent id

setPersistentId(string $persistentId) : \Zend\Cache\Storage\Adapter\RedisOptions

Parameters

$persistentId

string

Returns

\Zend\Cache\Storage\Adapter\RedisOptions

Enable/Disable reading data from cache.

setReadable(bool $readable) : \Zend\Cache\Storage\Adapter\AbstractAdapter

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::setReadable()

Parameters

$readable

bool

Returns

\Zend\Cache\Storage\Adapter\AbstractAdapter

Set the redis resource id

setResourceId(string $resourceId) : \Zend\Cache\Storage\Adapter\RedisOptions

Parameters

$resourceId

string

Returns

\Zend\Cache\Storage\Adapter\RedisOptions

Set the redis resource manager to use

setResourceManager(\Zend\Cache\Storage\Adapter\RedisResourceManager $resourceManager) : \Zend\Cache\Storage\Adapter\RedisOptions

Parameters

$resourceManager

null\Zend\Cache\Storage\Adapter\RedisResourceManager

Returns

\Zend\Cache\Storage\Adapter\RedisOptions

Set server

setServer(string | array $server) : \Zend\Cache\Storage\Adapter\RedisOptions

Server can be described as follows: - URI: /path/to/sock.sock - Assoc: array('host' => [, 'port' => [, 'timeout' => ]]) - List: array([, , [, ]])

Parameters

$server

stringarray

Returns

\Zend\Cache\Storage\Adapter\RedisOptions

Set time to live.

setTtl(int | float $ttl) : \Zend\Cache\Storage\Adapter\AdapterOptions

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::setTtl()

Parameters

$ttl

intfloat

Returns

\Zend\Cache\Storage\Adapter\AdapterOptions

Enable/Disable writing data to cache.

setWritable(bool $writable) : \Zend\Cache\Storage\Adapter\AdapterOptions

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::setWritable()

Parameters

$writable

bool

Returns

\Zend\Cache\Storage\Adapter\AdapterOptions

Cast to array

toArray() : array

Inherited

inherited_from	\Zend\Stdlib\AbstractOptions::toArray()
inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::toArray()

Returns

array

Validates and normalize a TTL.

normalizeTtl(int | float $ttl) : void

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::normalizeTtl()

Parameters

$ttl

intfloat

Exceptions

`\Zend\Cache\Exception\InvalidArgumentException`

Triggers an option event if this options instance has a connection to an adapter implements EventsCapableInterface.

triggerOptionEvent(string $optionName, mixed $optionValue) : void

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::triggerOptionEvent()

Parameters

$optionName

string

$optionValue

mixed

Properties

We use the __ prefix to avoid collisions with properties in user-implementations.

$__strictMode__ : bool

Inherited

inherited_from	\Zend\Stdlib\AbstractOptions::$$__strictMode__
inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::$$__strictMode__

The adapter using these options

$adapter : null | \Zend\Cache\Storage\StorageInterface

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::$$adapter

Validate key against pattern

$keyPattern : string

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::$$keyPattern

Namespace option

$namespace : string

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::$$namespace

The namespace separator

$namespaceSeparator : string

Readable option

$readable : bool

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::$$readable

The resource id of the resource manager

$resourceId : string

The redis resource manager

$resourceManager : null | \Zend\Cache\Storage\Adapter\RedisResourceManager

TTL option

$ttl : int | float

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::$$ttl

Writable option

$writable : bool

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::$$writable