Methods

Constructor

__construct(array | \Traversable | null $options) 
Inherited

inherited_from \Zend\Stdlib\AbstractOptions::__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()

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

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

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

Parameters

$key

string

Exceptions

\Zend\Stdlib\Exception\InvalidArgumentException

Get automatic clearing factor

getClearingFactor() : int

Used by: - ClearExpiredByFactor

Returns

int

Get callback to call on intercepted exception

getExceptionCallback() : \Zend\Cache\Storage\Plugin\callable

Used by: - ExceptionHandler

Returns

\Zend\Cache\Storage\Plugin\callable

Exit if connection aborted and ignore_user_abort is disabled.

getExitOnAbort() : bool

Returns

bool

Set automatic optimizing factor

getOptimizingFactor() : int

Used by: - OptimizeByFactor

Returns

int

Get serializer

getSerializer() : \Zend\Serializer\Adapter\AdapterInterface

Used by: - Serializer

Returns

Get configuration options for instantiating a serializer adapter

getSerializerOptions() : array

Used by: - Serializer

Returns

array

Should we re-throw exceptions?

getThrowExceptions() : bool

Used by: - ExceptionHandler

Returns

bool

Set automatic clearing factor

setClearingFactor(int $clearingFactor) : \Zend\Cache\Storage\Plugin\PluginOptions

Used by: - ClearExpiredByFactor

Parameters

$clearingFactor

int

Returns

Set callback to call on intercepted exception

setExceptionCallback(\Zend\Cache\Storage\Plugin\callable $exceptionCallback) : \Zend\Cache\Storage\Plugin\PluginOptions

Used by: - ExceptionHandler

Parameters

$exceptionCallback

\Zend\Cache\Storage\Plugin\callable

Exceptions

\Zend\Cache\Exception\InvalidArgumentException

Returns

Exit if connection aborted and ignore_user_abort is disabled.

setExitOnAbort(bool $exitOnAbort) : \Zend\Cache\Storage\Plugin\PluginOptions

Parameters

$exitOnAbort

bool

Returns

Set one or more configuration properties

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

inherited_from \Zend\Stdlib\AbstractOptions::setFromArray()

Parameters

$options

array\Traversable\Zend\Stdlib\AbstractOptions

Exceptions

\Zend\Stdlib\Exception\InvalidArgumentException

Returns

\Zend\Stdlib\AbstractOptionsProvides fluent interface

Set automatic optimizing factor

setOptimizingFactor(int $optimizingFactor) : \Zend\Cache\Storage\Plugin\PluginOptions

Used by: - OptimizeByFactor

Parameters

$optimizingFactor

int

Returns

Set serializer

setSerializer(string | \Zend\Serializer\Adapter\AdapterInterface $serializer) : \Zend\Cache\Storage\Plugin\self

Used by: - Serializer

Parameters

Exceptions

\Zend\Cache\Exception\InvalidArgumentException

Returns

\Zend\Cache\Storage\Plugin\self

Set configuration options for instantiating a serializer adapter

setSerializerOptions(mixed $serializerOptions) : \Zend\Cache\Storage\Plugin\PluginOptions

Used by: - Serializer

Parameters

$serializerOptions

mixed

Returns

Set flag indicating we should re-throw exceptions

setThrowExceptions(bool $throwExceptions) : \Zend\Cache\Storage\Plugin\PluginOptions

Used by: - ExceptionHandler

Parameters

$throwExceptions

bool

Returns

Cast to array

toArray() : array
Inherited

inherited_from \Zend\Stdlib\AbstractOptions::toArray()

Returns

array

Normalize a factor

normalizeFactor(int $factor) : int

Cast to int and ensure we have a value greater than zero.

Parameters

$factor

int

Exceptions

\Zend\Cache\Exception\InvalidArgumentException

Returns

int

 Properties

 

We use the __ prefix to avoid collisions with properties in user-implementations.

$__strictMode__ : bool
Inherited

inherited_from \Zend\Stdlib\AbstractOptions::$$__strictMode__
 

Used by: - ClearByFactor

$clearingFactor : int

 

Used by: - ExceptionHandler

$exceptionCallback : \Zend\Cache\Storage\Plugin\callable

 

Used by: - IgnoreUserAbort

$exitOnAbort : bool

 

Used by: - OptimizeByFactor

$optimizingFactor : int

 

Used by: - Serializer

$serializer : string | \Zend\Serializer\Adapter\AdapterInterface

 

Used by: - Serializer

$serializerOptions : array

 

Used by: - ExceptionHandler

$throwExceptions : bool