package Default
inherited_from \Zend\Stdlib\AbstractOptions

 Methods

Constructor

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

Parameters

$options

array\Traversablenull

Get a configuration property

__get(string $key) : mixed
Inherited
see
inherited_from \Zend\Stdlib\ParameterObjectInterface::__get()

Parameters

$key

string

Exceptions

\Zend\Stdlib\Exception\BadMethodCallException

Returns

mixed

Test if a configuration property is null

__isset(string $key) : boolean
Inherited
see
inherited_from \Zend\Stdlib\ParameterObjectInterface::__isset()

Parameters

$key

string

Returns

boolean

Set a configuration property

__set(string $key, mixed $value) : void
Inherited
see
inherited_from \Zend\Stdlib\ParameterObjectInterface::__set()

Parameters

$key

string

$value

mixed

Exceptions

\Zend\Stdlib\Exception\BadMethodCallException

Set a configuration property to NULL

__unset(string $key) : void
Inherited
see
inherited_from \Zend\Stdlib\ParameterObjectInterface::__unset()

Parameters

$key

string

Exceptions

\Zend\Stdlib\Exception\InvalidArgumentException

Get automatic clearing factor

getClearingFactor() : integer

Used by:

  • ClearExpiredByFactor

Returns

integer

Get callback to call on intercepted exception

getExceptionCallback() : null | callable

Used by:

  • ExceptionHandler

Returns

nullcallable

Exit if connection aborted and ignore_user_abort is disabled.

getExitOnAbort() : boolean

Returns

boolean

Set automatic optimizing factor

getOptimizingFactor() : integer

Used by:

  • OptimizeByFactor

Returns

integer

Get serializer

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

Used by:

  • Serializer

Returns

\Zend\Serializer\Adapter\AdapterInterface

Get configuration options for instantiating a serializer adapter

getSerializerOptions() : array

Used by:

  • Serializer

Returns

array

Should we re-throw exceptions?

getThrowExceptions() : boolean

Used by:

  • ExceptionHandler

Returns

boolean

Set automatic clearing factor

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

Used by:

  • ClearExpiredByFactor

Parameters

$clearingFactor

integer

Returns

\Zend\Cache\Storage\Plugin\PluginOptions

Set callback to call on intercepted exception

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

Used by:

  • ExceptionHandler

Parameters

$exceptionCallback

nullcallable

Exceptions

\Zend\Cache\Exception\InvalidArgumentException

Returns

\Zend\Cache\Storage\Plugin\PluginOptions

Exit if connection aborted and ignore_user_abort is disabled.

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

Parameters

$exitOnAbort

boolean

Returns

\Zend\Cache\Storage\Plugin\PluginOptions

Set one or more configuration properties

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

Parameters

$options

array\Traversable\Zend\Stdlib\AbstractOptions

Exceptions

\Zend\Stdlib\Exception\InvalidArgumentException

Returns

\Zend\Stdlib\AbstractOptionsProvides fluent interface

Set automatic optimizing factor

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

Used by:

  • OptimizeByFactor

Parameters

$optimizingFactor

integer

Returns

\Zend\Cache\Storage\Plugin\PluginOptions

Set serializer

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

Used by:

  • Serializer
fluent This method is part of a fluent interface and will return the same instance

Parameters

$serializer

string\Zend\Serializer\Adapter\AdapterInterface

Exceptions

\Zend\Cache\Exception\InvalidArgumentException

Returns

\Zend\Cache\Storage\Plugin\PluginOptions

Set configuration options for instantiating a serializer adapter

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

Used by:

  • Serializer

Parameters

$serializerOptions

mixed

Returns

\Zend\Cache\Storage\Plugin\PluginOptions

Set flag indicating we should re-throw exceptions

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

Used by:

  • ExceptionHandler

Parameters

$throwExceptions

boolean

Returns

\Zend\Cache\Storage\Plugin\PluginOptions

Cast to array

toArray() : array
Inherited

Returns

array

Normalize a factor

normalizeFactor(integer $factor) : integer

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

Parameters

$factor

integer

Exceptions

\Zend\Cache\Exception\InvalidArgumentException

Returns

integer

 Properties

 

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

$__strictMode__ : boolean

Default

true
 

Used by: - ClearByFactor

$clearingFactor : integer

Default

0
 

Used by: - ExceptionHandler

$exceptionCallback : null | callable

Default

 

Used by: - IgnoreUserAbort

$exitOnAbort : boolean

Default

true
 

Used by: - OptimizeByFactor

$optimizingFactor : integer

Default

0
 

Used by: - Serializer

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

Default

 

Used by: - Serializer

$serializerOptions : array

Default

array()
 

Used by: - ExceptionHandler

$throwExceptions : boolean

Default

true