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.

Direct Implementers

Namespace: Cake\Event
Location: Event/EventInterface.php

Magic 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

  • getData() public
    Accesses 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
    Checks 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.
  • Stops the event from being used anymore.

Method Detail

getData()source public 

getData( string|null $key = null )

Accesses the event data/payload.

Parameters

string|null $key optional null
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()source public 

getName( )

Returns the name of this event. This is usually used as the event identifier.

Returns

string

getResult()source public 

getResult( )

The result value of the event listeners.

Returns

mixed

getSubject()source public 

getSubject( )

Returns the subject of this event.

Returns

object

isStopped()source public 

isStopped( )

Checks if the event is stopped.

Returns

boolean
True if the event is stopped

setData()source 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

setResult()source 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

stopPropagation()source public 

stopPropagation( )

Stops the event from being used anymore.

Magic properties detail

$datasource

public array

$namesource

public string

$resultsource

public mixed

$subjectsource

public 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.7/class-Cake.Event.EventInterface.html