Class CakeEvent
Represents the transport class of events across the system. It receives a name, subject and an optional payload. The name can be any string that uniquely identifies the event across the application, while the subject represents the object that the event applies to.
Copyright: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
License: MIT License
Location: Cake/Event/CakeEvent.php
Properties summary
-
$_name
protectedName of the eventstring
-
$_stopped
protectedFlags an event as stopped or not, default is falseboolean
-
$_subject
protectedThe object this event applies to (usually the same object that generates the event)object
-
$data
publicCustom data for the method that receives the eventmixed
-
$result
publicProperty used to retain the result value of the event listenersmixed
Method Summary
- __construct() publicConstructor
- __get() publicDynamically returns the name and subject if accessed directly
- isStopped() publicCheck if the event is stopped
- name() publicReturns the name of this event. This is usually used as the event identifier
- stopPropagation() publicStops the event from being used anymore
- subject() publicReturns the subject of this event
Method Detail
__construct()source public
__construct( string $name , object $subject null , mixed $data null )
Constructor
Parameters
- string
$name
- Name of the event
- object
$subject
optional null - the object that this event applies to (usually the object that is generating the event)
- mixed
$data
optional null -
any value you wish to be transported with this event to it can be read by listeners
Examples of usage:
$event = new CakeEvent('Order.afterBuy', $this, array('buyer' => $userData)); $event = new CakeEvent('User.afterRegister', $UserModel);
__get()source public
__get( string $attribute )
Dynamically returns the name and subject if accessed directly
Parameters
- string
$attribute
- Attribute name.
Returns
mixedisStopped()source public
isStopped( )
Check if the event is stopped
Returns
booleanTrue if the event is stopped
name()source public
name( )
Returns the name of this event. This is usually used as the event identifier
Returns
stringProperties detail
$_subjectsource
protected object
The object this event applies to (usually the same object that generates the event)
© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.10/class-CakeEvent.html