\Cake\EventEventDispatcherInterface

Objects implementing this interface can emit events.

Objects with this interface can trigger events, and have an event manager retrieved from them.

The Cake\Event\EventDispatcherTrait lets you easily implement this interface.

Summary

Methods
Constants
dispatchEvent()
eventManager()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

dispatchEvent()

dispatchEvent(string  $name, array|null  $data = null, object|null  $subject = null) : \Cake\Event\Event

Wrapper for creating and dispatching events.

Returns a dispatched event.

Parameters

string $name

Name of the event.

array|null $data

Any value you wish to be transported with this event to it can be read by listeners.

object|null $subject

The object that this event applies to ($this by default).

Returns

\Cake\Event\Event

eventManager()

eventManager(\Cake\Event\EventManager|null  $eventManager = null) : \Cake\Event\EventManager

Returns the Cake\Event\EventManager manager instance for this object.

You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.

Parameters

\Cake\Event\EventManager|null $eventManager

the eventManager to set

Returns

\Cake\Event\EventManager