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

Method Detail

dispatchEvent() public 

dispatchEvent(string $name, ?array $data, ?object $subject)

Wrapper for creating and dispatching events.

Returns a dispatched event.

Parameters

string $name

Name of the event.

array|null $data optional

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

object|null $subject optional

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

Returns

\Cake\Event\EventInterface

getEventManager() public 

getEventManager()

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

Returns

\Cake\Event\EventManagerInterface

setEventManager() public 

setEventManager(\Cake\Event\EventManagerInterface $eventManager)

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.

Parameters

\Cake\Event\EventManagerInterface $eventManager

the eventManager to set

Returns

$this

© 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/4.0/interface-Cake.Event.EventDispatcherInterface.html