Zend Framework » \Zend\Cache\Storage\Adapter\MemcachedOptions

These are options specific to the APC adapter

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`

Add a server to the list

addServer(string $host, int $port, int $weight) : \Zend\Cache\Storage\Adapter\MemcachedOptions

deprecated	Please use the resource manager instead

Parameters

$host

string

$port

int

$weight

int

Returns

\Zend\Cache\Storage\Adapter\MemcachedOptions

Get key pattern

getKeyPattern() : string

Inherited

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

Returns

string

Get libmemcached option

getLibOption(string | int $key) : mixed

link	http://php.net/manual/memcached.constants.php
deprecated	Please use lib_options or the resource manager instead

Parameters

$key

stringint

Returns

mixed

Get libmemcached options

getLibOptions() : array

link	http://php.net/manual/memcached.constants.php

Returns

array

Get memcached resource to share

getMemcachedResource() : \Memcached

deprecated	Please use the resource manager instead

Returns

\Memcached

Get namespace

getNamespace() : string

Inherited

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

Returns

string

Get namespace separator

getNamespaceSeparator() : 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 memcached resource id

getResourceId() : string

Returns

string

Get the memcached resource manager

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

Returns

\Zend\Cache\Storage\Adapter\MemcachedResourceManager

Get Servers

getServers() : array

Returns

array

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 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 libmemcached option

setLibOption(string | int $key, mixed $value) : \Zend\Cache\Storage\Adapter\MemcachedOptions

link	http://php.net/manual/memcached.constants.php
deprecated	Please use lib_options or the resource manager instead

Parameters

$key

stringint

$value

mixed

Returns

\Zend\Cache\Storage\Adapter\MemcachedOptions

Set libmemcached options

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

link	http://php.net/manual/memcached.constants.php

Parameters

$libOptions

array

Returns

\Zend\Cache\Storage\Adapter\MemcachedOptions

A memcached resource to share

setMemcachedResource(\Memcached $memcachedResource) : \Zend\Cache\Storage\Adapter\MemcachedOptions

deprecated	Please use the resource manager instead

Parameters

$memcachedResource

null\Memcached

Returns

\Zend\Cache\Storage\Adapter\MemcachedOptions

Set namespace.

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

The option Memcached::OPT_PREFIX_KEY 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\MemcachedOptions::setPrefixKey()

Parameters

$namespace

string

Returns

\Zend\Cache\Storage\Adapter\AdapterOptions

Set namespace separator

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

Parameters

$namespaceSeparator

string

Returns

\Zend\Cache\Storage\Adapter\MemcachedOptions

Set the persistent id

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

Parameters

$persistentId

string

Returns

\Zend\Cache\Storage\Adapter\MemcachedOptions

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 memcached resource id

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

Parameters

$resourceId

string

Returns

\Zend\Cache\Storage\Adapter\MemcachedOptions

Set the memcached resource manager to use

setResourceManager(\Zend\Cache\Storage\Adapter\MemcachedResourceManager $resourceManager) : \Zend\Cache\Storage\Adapter\MemcachedOptions

Parameters

$resourceManager

null\Zend\Cache\Storage\Adapter\MemcachedResourceManager

Returns

\Zend\Cache\Storage\Adapter\MemcachedOptions

Set a list of memcached servers to add on initialize

setServers(string | array $servers) : \Zend\Cache\Storage\Adapter\MemcachedOptions

Parameters

$servers

stringarray

list of servers

Exceptions

`\Zend\Cache\Exception\InvalidArgumentException`

Returns

\Zend\Cache\Storage\Adapter\MemcachedOptions

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\Adapter\Filesystem

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 memcached resource manager

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

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