These are options specific to the APC adapter

category Zend
package Zend_Cache
subpackage Storage

 Methods

__construct()

__construct(array | \Traversable | null $options) : \Zend\Stdlib\AbstractOptions
Inherited

inherited_from \Zend\Stdlib\AbstractOptions::__construct()
inherited_from \Zend\Cache\Storage\Adapter\AdapterOptions::__construct()

Parameters

$options

array\Traversablenull

Exceptions

\Zend\Stdlib\Exception\InvalidArgumentException

Returns

__get()

__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

__isset()

__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()

__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

__unset()

__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

Get key pattern

getKeyPattern() : string
Inherited

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

Returns

string

Get memory limit

getMemoryLimit() : int

If the used memory of PHP exceeds this limit an OutOfSpaceException will be thrown.

Returns

int

Get namespace

getNamespace() : string
Inherited

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

Returns

string

If reading data from cache enabled.

getReadable() : bool
Inherited

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

Returns

bool

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

Returns

setFromArray()

setFromArray(array | \Traversable $options) : void
Inherited

inherited_from \Zend\Stdlib\AbstractOptions::setFromArray()
inherited_from \Zend\Cache\Storage\Adapter\AdapterOptions::setFromArray()

Parameters

$options

array\Traversable

Exceptions

\Zend\Stdlib\Exception\InvalidArgumentException

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

Set memory limit

setMemoryLimit(string | int $memoryLimit) : \Zend\Cache\Storage\Adapter\MemoryOptions

  • A number less or equal 0 will disable the memory limit
  • When a number is used, the value is measured in bytes. Shorthand notation may also be used.
  • If the used memory of PHP exceeds this limit an OutOfSpaceException will be thrown.

link http://php.net/manual/faq.using.php#faq.using.shorthandbytes

Parameters

$memoryLimit

stringint

Returns

Set namespace.

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

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

Parameters

$namespace

string

Returns

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

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

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

Cast to array

toArray() : array
Inherited

inherited_from \Zend\Stdlib\AbstractOptions::toArray()
inherited_from \Zend\Cache\Storage\Adapter\AdapterOptions::toArray()

Returns

array

Normalized a given value of memory limit into the number of bytes

normalizeMemoryLimit(string | int $value) : int

Parameters

$value

stringint

Exceptions

\Zend\Cache\Exception\InvalidArgumentException

Returns

int

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
 

memory limit

$memoryLimit : null | int

 

Namespace option

$namespace : string
Inherited

inherited_from \Zend\Cache\Storage\Adapter\AdapterOptions::$$namespace
 

Readable option

$readable : bool
Inherited

inherited_from \Zend\Cache\Storage\Adapter\AdapterOptions::$$readable
 

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