Class Event
Class Event
- Cake\Event\Event implements Cake\Event\EventInterface
Properties summary
-
$_dataprotectedarrayCustom data for the method that receives the event -
$_nameprotectedstringName of the event -
$_stoppedprotectedbooleanFlags an event as stopped or not, default is false -
$_subjectprotectedobject|nullThe object this event applies to (usually the same object that generates the event) -
$resultpublicmixedProperty used to retain the result value of the event listeners
Method Summary
-
__construct() public
Constructor -
__get() public deprecated
Provides read-only access for the name and subject properties. -
__set() public deprecated
Provides backward compatibility for write access to data and result properties. -
data() public deprecated
Access the event data/payload. -
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 -
name() public deprecated
Returns the name of this event. This is usually used as the event identifier -
result() public deprecated
The result value of the event listeners -
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 -
subject() public deprecated
Returns the subject of this event
Method Detail
__construct() public ¶
__construct( string $name , object|null $subject = null , array|ArrayAccess|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 null
- the object that this event applies to (usually the object that is generating the event)
- array|ArrayAccess|null $data optional null
- any value you wish to be transported with this event to it can be read by listeners
__get() public deprecated ¶
__get( string $attribute )
Provides read-only access for the name and subject properties.
Deprecated
Parameters
- string $attribute
- Attribute name.
Returns
__set() public deprecated ¶
__set( string $attribute , mixed $value )
Provides backward compatibility for write access to data and result properties.
Deprecated
Parameters
- string $attribute
- Attribute name.
- mixed $value
- The value to set.
data() public deprecated ¶
data( string|null $key = null )
Access the event data/payload.
Deprecated
Parameters
- string|null $key optional null
- The data payload element to return, or null to return all data.
Returns
The 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.
getData() public ¶
getData( string|null $key = null )
Access the event data/payload.
Parameters
- string|null $key optional null
- The data payload element to return, or null to return all data.
Returns
The 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.
Implementation of
getName() public ¶
getName( )
Returns the name of this event. This is usually used as the event identifier
Returns
Implementation of
getResult() public ¶
getResult( )
The result value of the event listeners
Returns
Implementation of
getSubject() public ¶
getSubject( )
Returns the subject of this event
Returns
Implementation of
isStopped() public ¶
isStopped( )
Check if the event is stopped
Returns
True if the event is stopped
Implementation of
name() public deprecated ¶
name( )
Returns the name of this event. This is usually used as the event identifier
Deprecated
Returns
result() public deprecated ¶
result( )
The result value of the event listeners
Deprecated
Returns
setData() public ¶
setData( array|string $key , mixed $value = null )
Assigns 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 null
- The value to set.
Returns
$this
Implementation of
setResult() public ¶
setResult( mixed $value = null )
Listeners can attach a result value to the event.
Parameters
- mixed $value optional null
- The value to set.
Returns
$this
Implementation of
stopPropagation() public ¶
stopPropagation( )
Stops the event from being used anymore