Summary

Fully Qualified Name:	Laminas\Cache\Storage\Plugin\PluginOptions
Extends:	AbstractOptions

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
getClearingFactor()	Get automatic clearing factor	PluginOptions
getExceptionCallback()	Get callback to call on intercepted exception	PluginOptions
getExitOnAbort()	Exit if connection aborted and ignore_user_abort is disabled.	PluginOptions
getOptimizingFactor()	Set automatic optimizing factor	PluginOptions
getSerializer()	Get serializer	PluginOptions
getSerializerOptions()	Get configuration options for instantiating a serializer adapter	PluginOptions
getThrowExceptions()	Should we re-throw exceptions?	PluginOptions
setClearingFactor()	Set automatic clearing factor	PluginOptions
setExceptionCallback()	Set callback to call on intercepted exception	PluginOptions
setExitOnAbort()	Exit if connection aborted and ignore_user_abort is disabled.	PluginOptions
setFromArray()	Set one or more configuration properties	AbstractOptions
setOptimizingFactor()	Set automatic optimizing factor	PluginOptions
setSerializer()	Set serializer	PluginOptions
setSerializerOptions()	Set configuration options for instantiating a serializer adapter	PluginOptions
setThrowExceptions()	Set flag indicating we should re-throw exceptions	PluginOptions
toArray()	Cast to array	AbstractOptions

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

getClearingFactor()

Get automatic clearing factor

Used by:

• ClearExpiredByFactor

Returns: int

getExceptionCallback()

Get callback to call on intercepted exception

Used by:

• ExceptionHandler

Returns: null|callable

getExitOnAbort()

Exit if connection aborted and ignore_user_abort is disabled.

Returns: bool

getOptimizingFactor()

Set automatic optimizing factor

Used by:

• OptimizeByFactor

Returns: int

getSerializer()

Get serializer

Used by:

• Serializer

Returns: \SerializerAdapter

getSerializerOptions()

Get configuration options for instantiating a serializer adapter

Used by:

• Serializer

Returns: array

getThrowExceptions()

Should we re-throw exceptions?

Used by:

• ExceptionHandler

Returns: bool

setClearingFactor()

Set automatic clearing factor

Used by:

• ClearExpiredByFactor

Parameter Name	Type	Description
$clearingFactor	int

Returns: \PluginOptions Provides a fluent interface

setExceptionCallback()

Set callback to call on intercepted exception

Used by:

• ExceptionHandler

Parameter Name	Type	Description
$exceptionCallback	null|callable

Returns: \PluginOptions Provides a fluent interface

setExitOnAbort()

Exit if connection aborted and ignore_user_abort is disabled.

Parameter Name	Type	Description
$exitOnAbort	bool

Returns: \PluginOptions Provides a fluent interface

setFromArray()

Set one or more configuration properties

Parameter Name	Type	Description
$options	array|\Traversable|\AbstractOptions

Returns: \AbstractOptions Provides fluent interface

setOptimizingFactor()

Set automatic optimizing factor

Used by:

• OptimizeByFactor

Parameter Name	Type	Description
$optimizingFactor	int

Returns: \PluginOptions Provides a fluent interface

setSerializer()

Set serializer

Used by:

• Serializer

Parameter Name	Type	Description
$serializer	string|\SerializerAdapter

Returns: \PluginOptions Provides a fluent interface

setSerializerOptions()

Set configuration options for instantiating a serializer adapter

Used by:

• Serializer

Parameter Name	Type	Description
$serializerOptions	mixed

Returns: \PluginOptions Provides a fluent interface

setThrowExceptions()

Set flag indicating we should re-throw exceptions

Used by:

• ExceptionHandler

Parameter Name	Type	Description
$throwExceptions	bool

Returns: \PluginOptions Provides a fluent interface

toArray()

Cast to array

Returns: array