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.

Properties summary

• $_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)
• $data public
  mixed
  Custom data for the method that receives the event
• $result public
  mixed
  Property used to retain the result value of the event listeners

Method Summary

• __construct() public
  Constructor
• __get() public
  Dynamically returns the name and subject if accessed directly
• data() public
  Access the event data/payload.
• isStopped() public
  Check if the event is stopped
• name() public
  Returns the name of this event. This is usually used as the event identifier
• stopPropagation() public
  Stops the event from being used anymore
• subject() public
  Returns the subject of this event

Method Detail

__construct( string $name , object|null $subject null , array|null $data null )

$event = new Event('Order.afterBuy', $this, ['buyer' => $userData]);
 $event = new Event('User.afterRegister', $UserModel);

__get( string $attribute )

data( )

isStopped( )

name( )

stopPropagation( )

subject( )

Properties detail

null

false

null

null