Summary

Fully Qualified Name:	Laminas\Cache\Storage\Adapter\XCacheOptions
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
getAdminAuth()	Get admin authentication enabled	XCacheOptions
getAdminPass()	Get password to call admin functions	XCacheOptions
getAdminUser()	Get username to call admin functions	XCacheOptions
getKeyPattern()	Get key pattern	AdapterOptions
getNamespace()	Get namespace	AdapterOptions
getNamespaceSeparator()	Get namespace separator	XCacheOptions
getReadable()	If reading data from cache enabled.	AdapterOptions
getTtl()	Get time to live.	AdapterOptions
getWritable()	If writing data to cache enabled.	AdapterOptions
setAdapter()	Adapter using this instance	AdapterOptions
setAdminAuth()	Enable/Disable admin authentication handling	XCacheOptions
setAdminPass()	Set password to call admin functions	XCacheOptions
setAdminUser()	Set username to call admin functions	XCacheOptions
setFromArray()	{@inheritdoc}	AdapterOptions
setKeyPattern()	Set key pattern	AdapterOptions
setNamespace()	Set namespace.	AdapterOptions
setNamespaceSeparator()	Set namespace separator	XCacheOptions
setReadable()	Enable/Disable reading data from cache.	AdapterOptions
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

getAdminAuth()

Get admin authentication enabled

Returns: bool

getAdminPass()

Get password to call admin functions

Returns: string

getAdminUser()

Get username to call admin functions

Returns: string

getKeyPattern()

Get key pattern

Returns: string

getNamespace()

Get namespace

Returns: string

getNamespaceSeparator()

Get namespace separator

Returns: string

getReadable()

If reading data from cache enabled.

Returns: bool

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

setAdminAuth()

Enable/Disable admin authentication handling

Parameter Name	Type	Description
$adminAuth	bool

Returns: \XCacheOptions Provides a fluent interface

setAdminPass()

Set password to call admin functions

Parameter Name	Type	Description
$adminPass	null|string

Returns: \XCacheOptions Provides a fluent interface

setAdminUser()

Set username to call admin functions

Parameter Name	Type	Description
$adminUser	null|string

Returns: \XCacheOptions 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

setNamespace()

Set namespace.

Parameter Name	Type	Description
$namespace	string

Returns: \AdapterOptions Provides a fluent interface

setNamespaceSeparator()

Set namespace separator

Parameter Name	Type	Description
$namespaceSeparator	string

Returns: \XCacheOptions Provides a fluent interface

setReadable()

Enable/Disable reading data from cache.

Parameter Name	Type	Description
$readable	bool

Returns: \AdapterOptions 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