Interface EventInterface
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.
Properties summary
- $data public
array
(deprecated) Custom data for the method that receives the event
- $name public
string
(deprecated) Name of the event
- $result public
mixed
(deprecated) Property used to retain the result value of the event listeners
- $subject public
object
(deprecated) The object this event applies to
Method Summary
Method Detail
getData() public
getData(mixed $key)
Accesses the event data/payload.
Parameters
-
string|null
$key optional The data payload element to return, or null to return all data.
Returns
array|mixed|null
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.
getName() public
getName()
Returns the name of this event. This is usually used as the event identifier.
Returns
string
getResult() public
getResult()
The result value of the event listeners.
Returns
mixed
getSubject() public
getSubject()
Returns the subject of this event.
Returns
object
isStopped() public
isStopped()
Checks if the event is stopped.
Returns
bool
True if the event is stopped
setData() public
setData(mixed $key, mixed $value)
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 The value to set.
Returns
$this
setResult() public
setResult(mixed $value)
Listeners can attach a result value to the event.
Parameters
-
mixed
$value optional The value to set.
Returns
$this
stopPropagation() public
stopPropagation()
Stops the event from being used anymore.
Property Detail
$data public
(deprecated) Custom data for the method that receives the event
Type
array
$name public
(deprecated) Name of the event
Type
string
$result public
(deprecated) Property used to retain the result value of the event listeners
Type
mixed
$subject public
(deprecated) The object this event applies to
Type
object
© 2005–present 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/3.9/interface-Cake.Event.EventInterface.html