Summary

Fully Qualified Name:	Laminas\Cache\Storage\Adapter\RedisOptions
Extends:	AdapterOptions

Description

Methods

Name	Description	Defined By
__construct()	Constructor	AbstractOptions
__get()	Get a configuration property	AbstractOptions
__isset()	Test if a configuration property is null	AbstractOptions
__set()	Set a configuration property	AbstractOptions
__unset()	Set a configuration property to NULL	AbstractOptions
getDatabase()	Get resource database number	RedisOptions
getKeyPattern()	Get key pattern	AdapterOptions
getLibOptions()	Get redis options	RedisOptions
getNamespace()	Get namespace	AdapterOptions
getNamespaceSeparator()	Get namespace separator	RedisOptions
getPassword()	Get resource password	RedisOptions
getPersistentId()	Get the persistent id	RedisOptions
getReadable()	If reading data from cache enabled.	AdapterOptions
getResourceId()	Get the redis resource id	RedisOptions
getResourceManager()	Get the redis resource manager	RedisOptions
getServer()	Get server	RedisOptions
getTtl()	Get time to live.	AdapterOptions
getWritable()	If writing data to cache enabled.	AdapterOptions
setAdapter()	Adapter using this instance	AdapterOptions
setDatabase()	Set resource database number	RedisOptions
setFromArray()	{@inheritdoc}	AdapterOptions
setKeyPattern()	Set key pattern	AdapterOptions
setLibOptions()	Set redis options	RedisOptions
setNamespace()	Set namespace.	RedisOptions
setNamespaceSeparator()	Set namespace separator	RedisOptions
setPassword()	Set resource password	RedisOptions
setPersistentId()	Set the persistent id	RedisOptions
setReadable()	Enable/Disable reading data from cache.	AdapterOptions
setResourceId()	Set the redis resource id	RedisOptions
setResourceManager()	Set the redis resource manager to use	RedisOptions
setServer()	Set server	RedisOptions
setTtl()	Set time to live.	AdapterOptions
setWritable()	Enable/Disable writing data to cache.	AdapterOptions
toArray()	Cast to array	AdapterOptions

Method Details

__construct()

Constructor

Parameter Name	Type	Description
$options	array|\Traversable|null

Returns:

__get()

Get a configuration property

Parameter Name	Type	Description
$key	string

Returns: mixed

__isset()

Test if a configuration property is null

Parameter Name	Type	Description
$key	string

Returns: bool

__set()

Set a configuration property

Parameter Name	Type	Description
$key	string
$value	mixed

Returns: void

__unset()

Set a configuration property to NULL

Parameter Name	Type	Description
$key	string

Returns: void

getDatabase()

Get resource database number

Returns: int Database number

getKeyPattern()

Get key pattern

Returns: string

getLibOptions()

Get redis options

Returns: array

getNamespace()

Get namespace

Returns: string

getNamespaceSeparator()

Get namespace separator

Returns: string

getPassword()

Get resource password

Returns: string

getPersistentId()

Get the persistent id

Returns: string

getReadable()

If reading data from cache enabled.

Returns: bool

getResourceId()

Get the redis resource id

Returns: string

getResourceManager()

Get the redis resource manager

Returns: \RedisResourceManager

getServer()

Get server

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

getTtl()

Get time to live.

Returns: float

getWritable()

If writing data to cache enabled.

Returns: bool

setAdapter()

Adapter using this instance

Parameter Name	Type	Description
$adapter	\StorageInterface|null

Returns: \AdapterOptions Provides a fluent interface

setDatabase()

Set resource database number

Parameter Name	Type	Description
$database	int	Database

Returns: \RedisOptions Provides a fluent interface

setFromArray()

{@inheritdoc}

NOTE: This method was overwritten just to support prioritized properties {@link https://github.com/zendframework/zf2/issues/6381}

Parameter Name	Type	Description
$options	array|\Traversable|\AbstractOptions

Returns: \AbstractOptions Provides fluent interface

setKeyPattern()

Set key pattern

Parameter Name	Type	Description
$keyPattern	string

Returns: \AdapterOptions Provides a fluent interface

setLibOptions()

Set redis options

Parameter Name	Type	Description
$libOptions	array

Returns: \RedisOptions Provides a fluent interface

setNamespace()

Set namespace.

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

Parameter Name	Type	Description
$namespace	string	Prefix

Returns: \Laminas\Cache\Storage\Adapter\RedisOptions

setNamespaceSeparator()

Set namespace separator

Parameter Name	Type	Description
$namespaceSeparator	string

Returns: \RedisOptions Provides a fluent interface

setPassword()

Set resource password

Parameter Name	Type	Description
$password	string	Password

Returns: \RedisOptions Provides a fluent interface

setPersistentId()

Set the persistent id

Parameter Name	Type	Description
$persistentId	string

Returns: \RedisOptions Provides a fluent interface

setReadable()

Enable/Disable reading data from cache.

Parameter Name	Type	Description
$readable	bool

Returns: \AdapterOptions Provides a fluent interface

setResourceId()

Set the redis resource id

Parameter Name	Type	Description
$resourceId	string

Returns: \RedisOptions Provides a fluent interface

setResourceManager()

Set the redis resource manager to use

Parameter Name	Type	Description
$resourceManager	null|\RedisResourceManager

Returns: \RedisOptions Provides a fluent interface

setServer()

Set server

Server can be described as follows:

• URI: /path/to/sock.sock
• Assoc: array('host' => [, 'port' => [, 'timeout' => ]])
• List: array([, , [, ]])

Parameter Name	Type	Description
$server	string|array

Returns: \RedisOptions Provides a fluent interface

setTtl()

Set time to live.

Parameter Name	Type	Description
$ttl	int|float

Returns: \AdapterOptions Provides a fluent interface

setWritable()

Enable/Disable writing data to cache.

Parameter Name	Type	Description
$writable	bool

Returns: \AdapterOptions Provides a fluent interface

toArray()

Cast to array

Returns: array