Summary

Fully Qualified Name:	Zend\Cache\Storage\Adapter\MemcacheOptions
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
getAutoCompressMinSavings()	Get compress min savings	MemcacheOptions
getAutoCompressThreshold()	Get compress threshold	MemcacheOptions
getCompression()	Is compressed writes turned on?	MemcacheOptions
getFailureCallback()	Get callback for server connection failures	MemcacheOptions
getKeyPattern()	Get key pattern	AdapterOptions
getNamespace()	Get namespace	AdapterOptions
getNamespaceSeparator()	Get namespace separator	MemcacheOptions
getReadable()	If reading data from cache enabled.	AdapterOptions
getResourceId()	Get the memcache resource id	MemcacheOptions
getResourceManager()	Get the memcache resource manager	MemcacheOptions
getServerDefaults()	Get default server values	MemcacheOptions
getServers()	Get Servers	MemcacheOptions
getTtl()	Get time to live.	AdapterOptions
getWritable()	If writing data to cache enabled.	AdapterOptions
setAdapter()	Adapter using this instance	AdapterOptions
setAutoCompressMinSavings()	Set compress min savings option	MemcacheOptions
setAutoCompressThreshold()	Set compress threshold	MemcacheOptions
setCompression()	Set whether compressed writes are turned on or not	MemcacheOptions
setFailureCallback()	Set callback for server connection failures	MemcacheOptions
setFromArray()	{@inheritdoc}	AdapterOptions
setKeyPattern()	Set key pattern	AdapterOptions
setNamespace()	Set namespace.	MemcacheOptions
setNamespaceSeparator()	Set namespace separator	MemcacheOptions
setReadable()	Enable/Disable reading data from cache.	AdapterOptions
setResourceId()	Set the memcache resource id	MemcacheOptions
setResourceManager()	Set the memcache resource manager to use	MemcacheOptions
setServerDefaults()	Set default server values	MemcacheOptions
setServers()	Sets a list of memcache servers to add on initialize	MemcacheOptions
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

getAutoCompressMinSavings()

Get compress min savings

Returns:

getAutoCompressThreshold()

Get compress threshold

Returns: int|null

getCompression()

Is compressed writes turned on?

Returns: bool

getFailureCallback()

Get callback for server connection failures

Returns: callable

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

getResourceId()

Get the memcache resource id

Returns: string

getResourceManager()

Get the memcache resource manager

Returns: \MemcacheResourceManager

getServerDefaults()

Get default server values

Returns: array

getServers()

Get Servers

Returns: array

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

setAutoCompressMinSavings()

Set compress min savings option

Parameter Name	Type	Description
$minSavings	float|string|null

Returns: \MemcacheOptions

setAutoCompressThreshold()

Set compress threshold

Parameter Name	Type	Description
$threshold	int|string|array|\ArrayAccess|null

Returns: \MemcacheOptions

setCompression()

Set whether compressed writes are turned on or not

Parameter Name	Type	Description
$compression	bool

Returns: $this

setFailureCallback()

Set callback for server connection failures

Parameter Name	Type	Description
$callback	callable

Returns: $this

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.

It can't be longer than 128 characters.

Parameter Name	Type	Description
$namespace

Returns:

setNamespaceSeparator()

Set namespace separator

Parameter Name	Type	Description
$namespaceSeparator	string

Returns: \MemcacheOptions

setReadable()

Enable/Disable reading data from cache.

Parameter Name	Type	Description
$readable	bool

Returns: \AdapterOptions Provides a fluent interface

setResourceId()

Set the memcache resource id

Parameter Name	Type	Description
$resourceId	string

Returns: \MemcacheOptions

setResourceManager()

Set the memcache resource manager to use

Parameter Name	Type	Description
$resourceManager	null|\MemcacheResourceManager

Returns: \MemcacheOptions

setServerDefaults()

Set default server values

Parameter Name	Type	Description
$serverDefaults	array

Returns: \MemcacheOptions

setServers()

Sets a list of memcache servers to add on initialize

Parameter Name	Type	Description
$servers	string|array	list

Returns: \MemcacheOptions

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