Docs4dev
Docs
cakephp / 3.4 / class-cake.event.event.html

Class Event

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.

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

Properties summary

  • $_data protected
    array
    Custom data for the method that receives the event
  • $_name protected
    string
    Name of the event
  • $_stopped protected
    boolean
    Flags an event as stopped or not, default is false
  • $_subject protected
    object
    The object this event applies to (usually the same object that generates the event)
  • $result public
    mixed
    Property used to retain the result value of the event listeners

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

  • Constructor
  • __get() public
    Provides read-only access for the name and subject properties.
  • __set() public
    Provides backward compatibility for write access to data and result properties.
  • data() public
    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
    Returns the name of this event. This is usually used as the event identifier
  • result() public
    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.
  • Stops the event from being used anymore
  • subject() public
    Returns the subject of this event

Method Detail

__construct()source 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()source public

__get( string $attribute )

Provides read-only access for the name and subject properties.

Deprecated

3.4.0 Public properties will be removed.

Parameters

string $attribute
Attribute name.

Returns

mixed

__set()source public

__set( string $attribute , mixed $value )

Provides backward compatibility for write access to data and result properties.

Deprecated

3.4.0 Public properties will be removed.

Parameters

string $attribute
Attribute name.
mixed $value
The value to set.

data()source public

data( string|null $key null )

Access the event data/payload.

Deprecated

3.4.0 use getData() instead.

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.


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

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

Check if the event is stopped

Returns

boolean
True if the event is stopped

name()source public

name( )

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

Deprecated

3.4.0 use getName() instead.

Returns

string

result()source public

result( )

The result value of the event listeners

Deprecated

3.4.0 use getResult() instead.

Returns

mixed

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

subject()source public

subject( )

Returns the subject of this event

Deprecated

3.4.0 use getSubject() instead.

Returns

object

Properties detail

$_datasource

protected array

Custom data for the method that receives the event

$_namesource

protected string

Name of the event

$_stoppedsource

protected boolean

Flags an event as stopped or not, default is false

false

$_subjectsource

protected object

The object this event applies to (usually the same object that generates the event)

$resultsource

public mixed

Property used to retain the result value of the event listeners

Magic properties detail

$datasource

public array

$namesource

public string

$resultsource

public mixed

$subjectsource

public object

© 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/3.4/class-Cake.Event.Event.html