W3cubDocs

/CakePHP 3.4

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.

Direct Implementers

Indirect Implementers

Method Summary

  • Wrapper for creating and dispatching events.
  • Returns the Cake\Event\EventManager manager instance for this object.

Method Detail

dispatchEvent()source public

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

Wrapper for creating and dispatching events.

Returns a dispatched event.

Parameters

string $name
Name of the event.
array|null $data optional null

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

object|null $subject optional null

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

Returns

Cake\Event\Event

eventManager()source public

eventManager( Cake\Event\EventManager $eventManager null )

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 $eventManager optional null
the eventManager to set

Returns

Cake\Event\EventManager

© 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.EventDispatcherInterface.html