Class ExceptionEvent

Summary

Fully Qualified Name: Zend\Cache\Storage\ExceptionEvent
Extends: PostEvent

Description

Methods

Name Description Defined By
__construct() Constructor ExceptionEvent
getException() Get the exception to be thrown ExceptionEvent
getName() Get event name Event
getParam() Get an individual parameter Event
getParams() Get all parameters Event
getResult() Get the result/return value PostEvent
getStorage() Alias of getTarget Event
getTarget() Get the event target Event
getThrowException() Throw the exception or use the result ExceptionEvent
propagationIsStopped() Is propagation stopped? Event
setException() Set the exception to be thrown ExceptionEvent
setName() Set the event name Event
setParam() Set an individual parameter to a value Event
setParams() Set parameters Event
setResult() Set the result/return value PostEvent
setStorage() Alias of setTarget Event
setTarget() Set the event target/context Event
setThrowException() Throw the exception or use the result ExceptionEvent
stopPropagation() Stop further event propagation Event

Method Details

__construct()

Constructor

Accept a target and its parameters.

Parameter Name Type Description
$name string
$storage \StorageInterface
$params \ArrayObject
$result mixed
$exception \Exception

Returns:

getException()

Get the exception to be thrown

Returns: \Exception

getName()

Get event name

Returns: string

getParam()

Get an individual parameter

If the parameter does not exist, the $default value will be returned.

Parameter Name Type Description
$name string|int
$default mixed

Returns: mixed

getParams()

Get all parameters

Returns: array|object|\ArrayAccess

getResult()

Get the result/return value

Returns: mixed

getStorage()

Alias of getTarget

Returns: \StorageInterface

getTarget()

Get the event target

This may be either an object, or the name of a static method.

Returns: string|object

getThrowException()

Throw the exception or use the result

Returns: bool

propagationIsStopped()

Is propagation stopped?

Returns: bool

setException()

Set the exception to be thrown

Parameter Name Type Description
$exception \Exception

Returns: \ExceptionEvent

setName()

Set the event name

Parameter Name Type Description
$name string

Returns:

setParam()

Set an individual parameter to a value

Parameter Name Type Description
$name string|int
$value mixed

Returns:

setParams()

Set parameters

Overwrites parameters

Parameter Name Type Description
$params array|\ArrayAccess|object

Returns:

setResult()

Set the result/return value

Parameter Name Type Description
$value mixed

Returns: \PostEvent

setStorage()

Alias of setTarget

Parameter Name Type Description
$storage \StorageInterface

Returns: \Event

setTarget()

Set the event target/context

Parameter Name Type Description
$target null|string|object

Returns:

setThrowException()

Throw the exception or use the result

Parameter Name Type Description
$flag bool

Returns: \ExceptionEvent

stopPropagation()

Stop further event propagation

Parameter Name Type Description
$flag bool

Returns:

Top