ExceptionEvent
extends PostEvent
in package
Representation of an event
Encapsulates the target context and parameters passed, and provides some behavior for interacting with the event manager.
Table of Contents
- $exception : Exception
- The exception to be thrown
- $name : string
- $params : array<string|int, mixed>|ArrayAccess|object
- $result : mixed
- The result/return value
- $stopPropagation : bool
- $target : string|object
- $throwException : bool
- Throw the exception or use the result
- __construct() : mixed
- Constructor
- getException() : Exception
- Get the exception to be thrown
- getName() : string
- Get event name
- getParam() : mixed
- Get an individual parameter
- getParams() : array<string|int, mixed>|object|ArrayAccess
- Get all parameters
- getResult() : mixed
- Get the result/return value
- getStorage() : StorageInterface
- Alias of getTarget
- getTarget() : string|object
- Get the event target
- getThrowException() : bool
- Throw the exception or use the result
- propagationIsStopped() : bool
- Is propagation stopped?
- setException() : ExceptionEvent
- Set the exception to be thrown
- setName() : void
- Set the event name
- setParam() : void
- Set an individual parameter to a value
- setParams() : void
- Set parameters
- setResult() : PostEvent
- Set the result/return value
- setStorage() : Event
- Alias of setTarget
- setTarget() : void
- Set the event target/context
- setThrowException() : ExceptionEvent
- Throw the exception or use the result
- stopPropagation() : void
- Stop further event propagation
Properties
$exception
The exception to be thrown
protected
Exception
$exception
$name
protected
string
$name
Event name
$params
protected
array<string|int, mixed>|ArrayAccess|object
$params
= []
The event parameters
$result
The result/return value
protected
mixed
$result
$stopPropagation
protected
bool
$stopPropagation
= false
Whether or not to stop propagation
$target
protected
string|object
$target
The event target
$throwException
Throw the exception or use the result
protected
bool
$throwException
= true
Methods
__construct()
Constructor
public
__construct(string $name, StorageInterface $storage, ArrayObject $params, mixed &$result, Exception $exception) : mixed
Accept a target and its parameters.
Parameters
- $name : string
- $storage : StorageInterface
- $params : ArrayObject
- $result : mixed
- $exception : Exception
Return values
mixed —getException()
Get the exception to be thrown
public
getException() : Exception
Return values
Exception —getName()
Get event name
public
getName() : string
Return values
string —getParam()
Get an individual parameter
public
getParam(string|int $name[, mixed $default = null ]) : mixed
If the parameter does not exist, the $default value will be returned.
Parameters
- $name : string|int
- $default : mixed = null
Return values
mixed —getParams()
Get all parameters
public
getParams() : array<string|int, mixed>|object|ArrayAccess
Return values
array<string|int, mixed>|object|ArrayAccess —getResult()
Get the result/return value
public
& getResult() : mixed
Return values
mixed —getStorage()
Alias of getTarget
public
getStorage() : StorageInterface
Return values
StorageInterface —getTarget()
Get the event target
public
getTarget() : string|object
This may be either an object, or the name of a static method.
Return values
string|object —getThrowException()
Throw the exception or use the result
public
getThrowException() : bool
Return values
bool —propagationIsStopped()
Is propagation stopped?
public
propagationIsStopped() : bool
Return values
bool —setException()
Set the exception to be thrown
public
setException(Exception $exception) : ExceptionEvent
Parameters
- $exception : Exception
Return values
ExceptionEvent —setName()
Set the event name
public
setName(string $name) : void
Parameters
- $name : string
Return values
void —setParam()
Set an individual parameter to a value
public
setParam(string|int $name, mixed $value) : void
Parameters
- $name : string|int
- $value : mixed
Return values
void —setParams()
Set parameters
public
setParams(array<string|int, mixed>|ArrayAccess|object $params) : void
Overwrites parameters
Parameters
- $params : array<string|int, mixed>|ArrayAccess|object
Tags
Return values
void —setResult()
Set the result/return value
public
setResult(mixed &$value) : PostEvent
Parameters
- $value : mixed
Return values
PostEvent —setStorage()
Alias of setTarget
public
setStorage(StorageInterface $storage) : Event
Parameters
- $storage : StorageInterface
Tags
Return values
Event —setTarget()
Set the event target/context
public
setTarget(null|string|object $target) : void
Parameters
- $target : null|string|object
Return values
void —setThrowException()
Throw the exception or use the result
public
setThrowException(bool $flag) : ExceptionEvent
Parameters
- $flag : bool
Return values
ExceptionEvent —stopPropagation()
Stop further event propagation
public
stopPropagation([bool $flag = true ]) : void
Parameters
- $flag : bool = true