Class Event
Class Event
Property Summary
-
$_data protected
arrayCustom data for the method that receives the event
-
$_name protected
stringName of the event
-
$_stopped protected
boolFlags an event as stopped or not, default is false
-
$_subject protected
object|nullThe object this event applies to (usually the same object that generates the event)
-
$result protected
mixedProperty used to retain the result value of the event listeners
Method Summary
-
__construct() public
Constructor
-
getData() public
Access the event data/payload.
-
getName() public
Returns the name of this event. This is usually used as the event identifier
-
getResult() public
The result value of the event listeners
-
getSubject() public
Returns the subject of this event
-
isStopped() public
Check if the event is stopped
-
setData() public
Assigns a value to the data/payload of this event.
-
setResult() public
Listeners can attach a result value to the event.
-
stopPropagation() public
Stops the event from being used anymore
Method Detail
__construct() ¶ public
__construct(string $name, object|null $subject = null, ArrayAccess|array|null $data = null)Constructor
Examples of usage:
$event = new Event('Order.afterBuy', $this, ['buyer' => $userData]);
$event = new Event('User.afterRegister', $userModel);Parameters
-
string$name Name of the event
-
object|null$subject optional the object that this event applies to (usually the object that is generating the event).
-
ArrayAccess|array|null$data optional any value you wish to be transported with this event to it can be read by listeners.
getData() ¶ public
getData(string|null $key = null): mixed|array|nullAccess the event data/payload.
Parameters
-
string|null$key optional The data payload element to return, or null to return all data.
Returns
mixed|array|nullThe data payload if $key is null, or the data value for the given $key. If the $key does not exist a null value is returned.
getName() ¶ public
getName(): stringReturns the name of this event. This is usually used as the event identifier
Returns
stringgetSubject() ¶ public
getSubject(): objectReturns the subject of this event
If the event has no subject an exception will be raised.
Returns
objectThrows
Cake\Core\Exception\CakeExceptionisStopped() ¶ public
isStopped(): boolCheck if the event is stopped
Returns
boolTrue if the event is stopped
setData() ¶ public
setData(array|string $key, mixed $value = null): $thisAssigns a value to the data/payload of this event.
Parameters
-
array|string$key An array will replace all payload data, and a key will set just that array item.
-
mixed$value optional The value to set.
Returns
$thissetResult() ¶ public
setResult(mixed $value = null): $thisListeners can attach a result value to the event.
Parameters
-
mixed$value optional The value to set.
Returns
$thisstopPropagation() ¶ public
stopPropagation(): voidStops the event from being used anymore
Returns
void