\Cake\EventEventManagerInterface

Interface EventManagerInterface

Summary

Methods

Constants

on()
off()
dispatch()
listeners()

No constants found

No protected methods found

N/A

No private methods found

N/A

on(string|\Cake\Event\EventListenerInterface|null  $eventKey = null, array|callable  $options = array(), callable|null  $callable = null) : $this

Adds a new listener to an event.

A variadic interface to add listeners that emulates jQuery.on().

Binding an EventListenerInterface:

$eventManager->on($listener);

Binding with no options:

$eventManager->on('Model.beforeSave', $callable);

Binding with options:

$eventManager->on('Model.beforeSave', ['priority' => 90], $callable);

string\|\Cake\Event\EventListenerInterface\|null	$eventKey	The event unique identifier name with which the callback will be associated. If $eventKey is an instance of Cake\Event\EventListenerInterface its events will be bound using the `implementedEvents` methods.
array\|callable	$options	Either an array of options or the callable you wish to bind to $eventKey. If an array of options, the `priority` key can be used to define the order. Priorities are treated as queues. Lower values are called before higher ones, and multiple attachments added to the same priority queue will be treated in the order of insertion.
callable\|null	$callable	The callable function you want invoked.

\InvalidArgumentException: When event key is missing or callable is not an instance of Cake\Event\EventListenerInterface.

$this

off(string|\Cake\Event\EventListenerInterface  $eventKey, callable|null  $callable = null) : $this

Remove a listener from the active listeners.

Remove a EventListenerInterface entirely:

$manager->off($listener);

Remove all listeners for a given event:

$manager->off('My.event');

Remove a specific listener:

$manager->off('My.event', $callback);

Remove a callback from all events:

$manager->off($callback);

string\|\Cake\Event\EventListenerInterface	$eventKey	The event unique identifier name with which the callback has been associated, or the $listener you want to remove.
callable\|null	$callable	The callback you want to detach.

$this

dispatch(string|\Cake\Event\EventInterface  $event) : \Cake\Event\EventInterface

Dispatches a new event to all configured listeners

$event

The event key name or instance of EventInterface.

\Cake\Event\EventInterface