| Fully Qualified Name: | Laminas\Cache\Storage\ExceptionEvent |
| Extends: | PostEvent |
| 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 |
Constructor
Accept a target and its parameters.
| Parameter Name | Type | Description |
|---|---|---|
| $name | string | |
| $storage | \StorageInterface | |
| $params | \ArrayObject | |
| $result | mixed | |
| $exception | \Exception |
Returns:
Get the exception to be thrown
Returns: \Exception
Get event name
Returns: string
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
Get all parameters
Returns: array|object|\ArrayAccess
Get the result/return value
Returns: mixed
Alias of getTarget
Returns: \StorageInterface
Get the event target
This may be either an object, or the name of a static method.
Returns: string|object
Throw the exception or use the result
Returns: bool
Is propagation stopped?
Returns: bool
Set the exception to be thrown
| Parameter Name | Type | Description |
|---|---|---|
| $exception | \Exception |
Returns: \ExceptionEvent
Set the event name
| Parameter Name | Type | Description |
|---|---|---|
| $name | string |
Returns:
Set an individual parameter to a value
| Parameter Name | Type | Description |
|---|---|---|
| $name | string|int | |
| $value | mixed |
Returns:
Set parameters
Overwrites parameters
| Parameter Name | Type | Description |
|---|---|---|
| $params | array|\ArrayAccess|object |
Returns:
Set the result/return value
| Parameter Name | Type | Description |
|---|---|---|
| $value | mixed |
Returns: \PostEvent
Alias of setTarget
| Parameter Name | Type | Description |
|---|---|---|
| $storage | \StorageInterface |
Returns: \Event
Set the event target/context
| Parameter Name | Type | Description |
|---|---|---|
| $target | null|string|object |
Returns:
Throw the exception or use the result
| Parameter Name | Type | Description |
|---|---|---|
| $flag | bool |
Returns: \ExceptionEvent
Stop further event propagation
| Parameter Name | Type | Description |
|---|---|---|
| $flag | bool |
Returns: