Zend Framework » \Zend\Cache\Storage\ExceptionEvent

Representation of an event

Encapsulates the target context and parameters passed, and provides some behavior for interacting with the event manager.

Methods

Constructor

__construct(string $name, \Zend\Cache\Storage\StorageInterface $storage, \ArrayObject $params, mixed $result, \Exception $exception)

Accept a target and its parameters.

Parameters

$name

string

$storage

\Zend\Cache\Storage\StorageInterface

$params

\ArrayObject

$result

mixed

$exception

\Exception

Get the exception to be thrown

getException() : \Exception

Returns

\Exception

Get event name

getName() : string

Inherited

inherited_from	\Zend\EventManager\Event::getName()
inherited_from	\Zend\Cache\Storage\Event::getName()
inherited_from	\Zend\Cache\Storage\PostEvent::getName()

Returns

string

Get an individual parameter

getParam(string | int $name, mixed $default) : mixed

Inherited

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

inherited_from	\Zend\EventManager\Event::getParam()
inherited_from	\Zend\Cache\Storage\Event::getParam()
inherited_from	\Zend\Cache\Storage\PostEvent::getParam()

Parameters

$name

stringint

$default

mixed

Returns

mixed

Get all parameters

getParams() : array | object | \ArrayAccess

Inherited

inherited_from	\Zend\EventManager\Event::getParams()
inherited_from	\Zend\Cache\Storage\Event::getParams()
inherited_from	\Zend\Cache\Storage\PostEvent::getParams()

Returns

arrayobject\ArrayAccess

Get the result/return value

getResult() : mixed

Inherited

inherited_from	\Zend\Cache\Storage\PostEvent::getResult()

Returns

mixed

Alias of getTarget

getStorage() : \Zend\Cache\Storage\StorageInterface

Inherited

inherited_from	\Zend\Cache\Storage\Event::getStorage()
inherited_from	\Zend\Cache\Storage\PostEvent::getStorage()

Returns

\Zend\Cache\Storage\StorageInterface

Get the event target

getTarget() : string | object

Inherited

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

inherited_from	\Zend\EventManager\Event::getTarget()
inherited_from	\Zend\Cache\Storage\Event::getTarget()
inherited_from	\Zend\Cache\Storage\PostEvent::getTarget()

Returns

stringobject

Throw the exception or use the result

getThrowException() : bool

Returns

bool

Is propagation stopped?

propagationIsStopped() : bool

Inherited

inherited_from	\Zend\EventManager\Event::propagationIsStopped()
inherited_from	\Zend\Cache\Storage\Event::propagationIsStopped()
inherited_from	\Zend\Cache\Storage\PostEvent::propagationIsStopped()

Returns

bool

Set the exception to be thrown

setException(\Exception $exception) : \Zend\Cache\Storage\ExceptionEvent

Parameters

$exception

\Exception

Returns

\Zend\Cache\Storage\ExceptionEvent

Set the event name

setName(string $name) : \Zend\EventManager\Event

Inherited

inherited_from	\Zend\EventManager\Event::setName()
inherited_from	\Zend\Cache\Storage\Event::setName()
inherited_from	\Zend\Cache\Storage\PostEvent::setName()

Parameters

$name

string

Returns

\Zend\EventManager\Event

Set an individual parameter to a value

setParam(string | int $name, mixed $value) : \Zend\EventManager\Event

Inherited

inherited_from	\Zend\EventManager\Event::setParam()
inherited_from	\Zend\Cache\Storage\Event::setParam()
inherited_from	\Zend\Cache\Storage\PostEvent::setParam()

Parameters

$name

stringint

$value

mixed

Returns

\Zend\EventManager\Event

Set parameters

setParams(array | \ArrayAccess | object $params) : \Zend\EventManager\Event

Inherited

Overwrites parameters

inherited_from	\Zend\EventManager\Event::setParams()
inherited_from	\Zend\Cache\Storage\Event::setParams()
inherited_from	\Zend\Cache\Storage\PostEvent::setParams()

Parameters

$params

array\ArrayAccessobject

Exceptions

`\Zend\EventManager\Exception\InvalidArgumentException`

Returns

\Zend\EventManager\Event

Set the result/return value

setResult(mixed $value) : \Zend\Cache\Storage\PostEvent

Inherited

inherited_from	\Zend\Cache\Storage\PostEvent::setResult()

Parameters

$value

mixed

Returns

\Zend\Cache\Storage\PostEvent

Alias of setTarget

setStorage(\Zend\Cache\Storage\StorageInterface $storage) : \Zend\Cache\Storage\Event

Inherited

see	\Zend\EventManager\Event::setTarget()
inherited_from	\Zend\Cache\Storage\Event::setStorage()
inherited_from	\Zend\Cache\Storage\PostEvent::setStorage()

Parameters

$storage

\Zend\Cache\Storage\StorageInterface

Returns

\Zend\Cache\Storage\Event

Set the event target/context

setTarget(\Zend\Cache\Storage\StorageInterface $target) : \Zend\Cache\Storage\Event

Inherited

see	\Zend\EventManager\Event::setTarget()
inherited_from	\Zend\Cache\Storage\Event::setTarget()
inherited_from	\Zend\Cache\Storage\PostEvent::setTarget()

Parameters

$target

\Zend\Cache\Storage\StorageInterface

Returns

\Zend\Cache\Storage\Event

Throw the exception or use the result

setThrowException(bool $flag) : \Zend\Cache\Storage\ExceptionEvent

Parameters

$flag

bool

Returns

\Zend\Cache\Storage\ExceptionEvent

Stop further event propagation

stopPropagation(bool $flag) : void

Inherited

inherited_from	\Zend\EventManager\Event::stopPropagation()
inherited_from	\Zend\Cache\Storage\Event::stopPropagation()
inherited_from	\Zend\Cache\Storage\PostEvent::stopPropagation()

Parameters

$flag

bool

Properties

The exception to be thrown

$exception : \Exception

Event name

$name : string

Inherited

inherited_from	\Zend\EventManager\Event::$$name
inherited_from	\Zend\Cache\Storage\Event::$$name
inherited_from	\Zend\Cache\Storage\PostEvent::$$name

The event parameters

$params : array | \ArrayAccess | object

Inherited

inherited_from	\Zend\EventManager\Event::$$params
inherited_from	\Zend\Cache\Storage\Event::$$params
inherited_from	\Zend\Cache\Storage\PostEvent::$$params

The result/return value

$result : mixed

Inherited

inherited_from	\Zend\Cache\Storage\PostEvent::$$result

Whether or not to stop propagation

$stopPropagation : bool

Inherited

inherited_from	\Zend\EventManager\Event::$$stopPropagation
inherited_from	\Zend\Cache\Storage\Event::$$stopPropagation
inherited_from	\Zend\Cache\Storage\PostEvent::$$stopPropagation

The event target

$target : string | object

Inherited

inherited_from	\Zend\EventManager\Event::$$target
inherited_from	\Zend\Cache\Storage\Event::$$target
inherited_from	\Zend\Cache\Storage\PostEvent::$$target

Throw the exception or use the result

$throwException : bool

Methods

Constructor

Parameters

$name

$storage

$params

$result

$exception

Get the exception to be thrown

Returns

Get event name

Returns

Get an individual parameter

Parameters

$name

$default

Returns

Get all parameters

Returns

Get the result/return value

Returns

Alias of getTarget

Returns

Get the event target

Returns

Throw the exception or use the result

Returns

Is propagation stopped?

Returns

Set the exception to be thrown

Parameters

$exception

Returns

Set the event name

Parameters

$name

Returns

Set an individual parameter to a value

Parameters

$name

$value

Returns

Set parameters

Parameters

$params

Exceptions

Returns

Set the result/return value

Parameters

$value

Returns

Alias of setTarget

Parameters

$storage

Returns

Set the event target/context

Parameters

$target

Returns

Throw the exception or use the result

Parameters

$flag

Returns

Stop further event propagation

Parameters

$flag

Properties

The exception to be thrown

<p>Event name</p>

<p>The event parameters</p>

The result/return value

<p>Whether or not to stop propagation</p>

<p>The event target</p>

Throw the exception or use the result