PluginOptions Class Reference

Public Member Functions
	setClearingFactor ($clearingFactor)
	Set automatic clearing factor.
	getClearingFactor ()
	Get automatic clearing factor.
	setExceptionCallback ($exceptionCallback)
	Set callback to call on intercepted exception.
	getExceptionCallback ()
	Get callback to call on intercepted exception.
	setExitOnAbort ($exitOnAbort)
	Exit if connection aborted and ignore_user_abort is disabled.
	getExitOnAbort ()
	Exit if connection aborted and ignore_user_abort is disabled.
	setOptimizingFactor ($optimizingFactor)
	Set automatic optimizing factor.
	getOptimizingFactor ()
	Set automatic optimizing factor.
	setSerializer ($serializer)
	Set serializer.
	getSerializer ()
	Get serializer.
	setSerializerOptions ($serializerOptions)
	Set configuration options for instantiating a serializer adapter.
	getSerializerOptions ()
	Get configuration options for instantiating a serializer adapter.
	setThrowExceptions ($throwExceptions)
	Set flag indicating we should re-throw exceptions.
	getThrowExceptions ()
	Should we re-throw exceptions?
Public Member Functions inherited from AbstractOptions
	__construct ($options=null)
	Constructor.
	setFromArray ($options)
	Set one or more configuration properties.
	toArray ()
	Cast to array.
	__set ($key, $value)
	Set a configuration property.
	__get ($key)
	Get a configuration property.
	__isset ($key)
	Test if a configuration property is null.
	__unset ($key)
	Set a configuration property to NULL.

Protected Member Functions
	normalizeFactor ($factor)
	Normalize a factor.

Protected Attributes
	$clearingFactor = 0
	$exceptionCallback
	$exitOnAbort = true
	$optimizingFactor = 0
	$serializer
	$serializerOptions = []
	$throwExceptions = true
Protected Attributes inherited from AbstractOptions
	$__strictMode__ = true

Member Function Documentation

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

normalizeFactor (   $factor )

protected

Normalize a factor.

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

Parameters

int

$factor

Returns

int

Exceptions

Exception\InvalidArgumentException

setClearingFactor

(

$clearingFactor

)

Set automatic clearing factor.

Used by:

• ClearExpiredByFactor

Parameters

int

$clearingFactor

Returns

PluginOptions

setExceptionCallback

(

$exceptionCallback

)

Set callback to call on intercepted exception.

Used by:

• ExceptionHandler

Parameters

null | callable

$exceptionCallback

Exceptions

Exception\InvalidArgumentException

Returns

PluginOptions

setExitOnAbort

(

$exitOnAbort

)

Exit if connection aborted and ignore_user_abort is disabled.

Parameters

bool

$exitOnAbort

Returns

PluginOptions

setOptimizingFactor

(

$optimizingFactor

)

Set automatic optimizing factor.

Used by:

• OptimizeByFactor

Parameters

int

$optimizingFactor

Returns

PluginOptions

setSerializer

(

$serializer

)

Set serializer.

Used by:

• Serializer

Parameters

string | SerializerAdapter

$serializer

Exceptions

Exception\InvalidArgumentException

Returns

self

setSerializerOptions

(

$serializerOptions

)

Set configuration options for instantiating a serializer adapter.

Used by:

• Serializer

Parameters

mixed

$serializerOptions

Returns

PluginOptions

setThrowExceptions

(

$throwExceptions

)

Set flag indicating we should re-throw exceptions.

Used by:

• ExceptionHandler

Parameters

bool

$throwExceptions

Returns

PluginOptions

Member Data Documentation

$clearingFactor = 0

protected

$exceptionCallback

protected

$exitOnAbort = true

protected

$optimizingFactor = 0

protected

$serializer

protected

$serializerOptions = []

protected

$throwExceptions = true

protected