Interface EventDispatcherInterface

Objects implementing this interface can emit events.

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

The {@link \Cake\Event\EventDispatcherTrait} lets you easily implement this interface.

Namespace: Cake\Event

Method Summary

dispatchEvent() public

Wrapper for creating and dispatching events.
getEventManager() public

Returns the Cake\Event\EventManager manager instance for this object.
setEventManager() public

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

dispatchEvent(string $name, array $data = [], TSubject|null $subject = null): Cake\Event\EventInterface<TSubject>

Wrapper for creating and dispatching events.

Returns a dispatched event.

string $name: Name of the event.
array $data optional: Any value you wish to be transported with this event to it can be read by listeners.
TSubject|null $subject optional: The object that this event applies to ($this by default).

Cake\Event\EventInterface<TSubject>

getEventManager(): Cake\Event\EventManagerInterface

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

Cake\Event\EventManagerInterface

setEventManager(Cake\Event\EventManagerInterface $eventManager): $this

Sets 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.

$this