Summary

Fully Qualified Name:	Laminas\Cache\Storage\Adapter\MemcachedOptions
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
addServer()	Add a server to the list	MemcachedOptions
getKeyPattern()	Get key pattern	AdapterOptions
getLibOption()	Get libmemcached option	MemcachedOptions
getLibOptions()	Get libmemcached options	MemcachedOptions
getMemcachedResource()	Get memcached resource to share	MemcachedOptions
getNamespace()	Get namespace	AdapterOptions
getNamespaceSeparator()	Get namespace separator	MemcachedOptions
getPersistentId()	Get the persistent id	MemcachedOptions
getReadable()	If reading data from cache enabled.	AdapterOptions
getResourceId()	Get the memcached resource id	MemcachedOptions
getResourceManager()	Get the memcached resource manager	MemcachedOptions
getServers()	Get Servers	MemcachedOptions
getTtl()	Get time to live.	AdapterOptions
getWritable()	If writing data to cache enabled.	AdapterOptions
setAdapter()	Adapter using this instance	AdapterOptions
setFromArray()	{@inheritdoc}	AdapterOptions
setKeyPattern()	Set key pattern	AdapterOptions
setLibOption()	Set libmemcached option	MemcachedOptions
setLibOptions()	Set libmemcached options	MemcachedOptions
setMemcachedResource()	A memcached resource to share	MemcachedOptions
setNamespace()	Set namespace.	MemcachedOptions
setNamespaceSeparator()	Set namespace separator	MemcachedOptions
setPersistentId()	Set the persistent id	MemcachedOptions
setReadable()	Enable/Disable reading data from cache.	AdapterOptions
setResourceId()	Set the memcached resource id	MemcachedOptions
setResourceManager()	Set the memcached resource manager to use	MemcachedOptions
setServers()	Set a list of memcached servers to add on initialize	MemcachedOptions
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

addServer()

Add a server to the list

Parameter Name	Type	Description
$host	string
$port	int
$weight	int

Returns: \MemcachedOptions Provides a fluent interface

getKeyPattern()

Get key pattern

Returns: string

getLibOption()

Get libmemcached option

Parameter Name	Type	Description
$key	string|int

Returns: mixed

getLibOptions()

Get libmemcached options

Returns: array

getMemcachedResource()

Get memcached resource to share

Returns: \MemcachedResource

getNamespace()

Get namespace

Returns: string

getNamespaceSeparator()

Get namespace separator

Returns: string

getPersistentId()

Get the persistent id

Returns: string

getReadable()

If reading data from cache enabled.

Returns: bool

getResourceId()

Get the memcached resource id

Returns: string

getResourceManager()

Get the memcached resource manager

Returns: \MemcachedResourceManager

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

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

setLibOption()

Set libmemcached option

Parameter Name	Type	Description
$key	string|int
$value	mixed

Returns: \MemcachedOptions Provides a fluent interface

setLibOptions()

Set libmemcached options

Parameter Name	Type	Description
$libOptions	array

Returns: \MemcachedOptions Provides a fluent interface

setMemcachedResource()

A memcached resource to share

Parameter Name	Type	Description
$memcachedResource	null|\MemcachedResource

Returns: \MemcachedOptions Provides a fluent interface

setNamespace()

Set namespace.

The option Memcached::OPT_PREFIX_KEY will be used as the 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: \MemcachedOptions Provides a fluent interface

setPersistentId()

Set the persistent id

Parameter Name	Type	Description
$persistentId	string

Returns: \MemcachedOptions 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 memcached resource id

Parameter Name	Type	Description
$resourceId	string

Returns: \MemcachedOptions Provides a fluent interface

setResourceManager()

Set the memcached resource manager to use

Parameter Name	Type	Description
$resourceManager	null|\MemcachedResourceManager

Returns: \MemcachedOptions Provides a fluent interface

setServers()

Set a list of memcached servers to add on initialize

Parameter Name	Type	Description
$servers	string|array	list

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