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.
Method Summary
-
dispatchEvent() public
Wrapper for creating and dispatching events.
-
eventManager() public deprecated
Returns the Cake\Event\EventManager manager instance for this object.
-
getEventManager() public @method
-
setEventManager() public @method
Method Detail
dispatchEvent() ¶ public
dispatchEvent(string $name, array|null $data = null, object|null $subject = null): Cake\Event\EventWrapper 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\EventeventManager() ¶ public
eventManager(Cake\Event\EventManager|null $eventManager = null): Cake\Event\EventManagerReturns 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 optional the eventManager to set
Returns
Cake\Event\EventManagergetEventManager() ¶ public @method
getEventManager(): Cake\Event\EventManagerReturns
Cake\Event\EventManagersetEventManager() ¶ public @method
setEventManager(Cake\Event\EventManager $eventManager): $thisParameters
-
Cake\Event\EventManager$eventManager
Returns
$this