Class EventManager
The event manager is responsible for keeping track of event listeners, passing the correct data to them, and firing them in the correct order, when associated events are triggered. You can create multiple instances of this object to manage local events or keep a single instance and pass it around to manage all events in your app.
Property Summary
-
$_eventList protected
Cake\Event\EventList|nullThe event list object.
-
$_generalManager protected static
Cake\Event\EventManagerThe globally available instance, used for dispatching events attached from any scope
-
$_isGlobal protected
boolInternal flag to distinguish a common manager from the singleton
-
$_listeners protected
arrayList of listener callbacks associated to
-
$_trackEvents protected
boolEnables automatic adding of events to the event list object if it is present.
-
$defaultPriority public static
intThe default priority queue value for new, attached listeners
Method Summary
-
__debugInfo() public
Debug friendly object properties.
-
_attachSubscriber() protected
Auxiliary function to attach all implemented callbacks of a Cake\Event\EventListenerInterface class instance as individual methods on this manager
-
_callListener() protected
Calls a listener.
-
_detachSubscriber() protected
Auxiliary function to help detach all listeners provided by an object implementing EventListenerInterface
-
_extractCallable() protected
Auxiliary function to extract and return a PHP callback type out of the callable definition from the return value of the
implementedEventsmethod on a Cake\Event\EventListenerInterface -
addEventToList() public
Adds an event to the list if the event list object is present.
-
attach() public deprecated
Adds a new listener to an event.
-
detach() public deprecated
Removes a listener from the active listeners.
-
dispatch() public
Dispatches a new event to all configured listeners
-
getEventList() public
Returns the event list.
-
instance() public static
Returns the globally available instance of a Cake\Event\EventManager this is used for dispatching events attached from outside the scope other managers were created. Usually for creating hook systems or inter-class communication
-
isTrackingEvents() public
Returns whether this manager is set up to track events
-
listeners() public
Returns a list of all listeners for an eventKey in the order they should be called
-
matchingListeners() public
Returns the listeners matching a specified pattern
-
off() public
Remove a listener from the active listeners.
-
on() public
Adds a new listener to an event.
-
prioritisedListeners() public
Returns the listeners for the specified event key indexed by priority
-
setEventList() public
Enables the listing of dispatched events.
-
trackEvents() public
Enables / disables event tracking at runtime.
-
unsetEventList() public
Disables the listing of dispatched events.
Method Detail
_attachSubscriber() ¶ protected
_attachSubscriber(Cake\Event\EventListenerInterface $subscriber): voidAuxiliary function to attach all implemented callbacks of a Cake\Event\EventListenerInterface class instance as individual methods on this manager
Parameters
-
Cake\Event\EventListenerInterface$subscriber Event listener.
Returns
void_callListener() ¶ protected
_callListener(callable $listener, Cake\Event\Event $event): mixedCalls a listener.
Parameters
-
callable$listener The listener to trigger.
-
Cake\Event\Event$event Event instance.
Returns
mixed_detachSubscriber() ¶ protected
_detachSubscriber(Cake\Event\EventListenerInterface $subscriber, string|null $eventKey = null): voidAuxiliary function to help detach all listeners provided by an object implementing EventListenerInterface
Parameters
-
Cake\Event\EventListenerInterface$subscriber the subscriber to be detached
-
string|null$eventKey optional optional event key name to unsubscribe the listener from
Returns
void_extractCallable() ¶ protected
_extractCallable(array $function, Cake\Event\EventListenerInterface $object): callableAuxiliary function to extract and return a PHP callback type out of the callable definition
from the return value of the implementedEvents method on a Cake\Event\EventListenerInterface
Parameters
-
array$function the array taken from a handler definition for an event
-
Cake\Event\EventListenerInterface$object The handler object
Returns
callableaddEventToList() ¶ public
addEventToList(Cake\Event\Event $event): $thisAdds an event to the list if the event list object is present.
Parameters
-
Cake\Event\Event$event An event to add to the list.
Returns
$thisattach() ¶ public
attach(callableCake\Event\EventListenerInterface $callable, string|null $eventKey = null, array $options = []): voidAdds a new listener to an event.
Parameters
-
callableCake\Event\EventListenerInterface$callable PHP valid callback type or instance of Cake\Event\EventListenerInterface to be called when the event named with $eventKey is triggered. If a Cake\Event\EventListenerInterface instance is passed, then the
implementedEventsmethod will be called on the object to register the declared events individually as methods to be managed by this class. It is possible to define multiple event handlers per event name.-
string|null$eventKey optional The event unique identifier name with which the callback will be associated. If $callable is an instance of Cake\Event\EventListenerInterface this argument will be ignored
-
array$options optional used to set the
priorityflag to the listener. In the future more options may be added. 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.
Returns
voidThrows
InvalidArgumentExceptionWhen event key is missing or callable is not an instance of Cake\Event\EventListenerInterface.
detach() ¶ public
detach(callableCake\Event\EventListenerInterface $callable, string|null $eventKey = null): voidRemoves a listener from the active listeners.
Parameters
-
callableCake\Event\EventListenerInterface$callable any valid PHP callback type or an instance of EventListenerInterface
-
string|null$eventKey optional The event unique identifier name with which the callback has been associated
Returns
voiddispatch() ¶ public
dispatch(stringCake\Event\Event $event): Cake\Event\EventDispatches a new event to all configured listeners
Parameters
-
stringCake\Event\Event$event the event key name or instance of Event
Returns
Cake\Event\EventgetEventList() ¶ public
getEventList(): Cake\Event\EventListReturns the event list.
Returns
Cake\Event\EventListinstance() ¶ public static
instance(Cake\Event\EventManager|null $manager = null): staticReturns the globally available instance of a Cake\Event\EventManager this is used for dispatching events attached from outside the scope other managers were created. Usually for creating hook systems or inter-class communication
If called with the first parameter, it will be set as the globally available instance
Parameters
-
Cake\Event\EventManager|null$manager optional Event manager instance.
Returns
staticisTrackingEvents() ¶ public
isTrackingEvents(): boolReturns whether this manager is set up to track events
Returns
boollisteners() ¶ public
listeners(string $eventKey): arrayReturns a list of all listeners for an eventKey in the order they should be called
Parameters
-
string$eventKey Event key.
Returns
arraymatchingListeners() ¶ public
matchingListeners(string $eventKeyPattern): arrayReturns the listeners matching a specified pattern
Parameters
-
string$eventKeyPattern Pattern to match.
Returns
arrayoff() ¶ public
off(stringCake\Event\EventListenerInterface $eventKey, callable|null $callable = null): $thisRemove 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);Parameters
-
stringCake\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 optional The callback you want to detach.
Returns
$thison() ¶ public
on(stringCake\Event\EventListenerInterface|null $eventKey = null, array|callable $options = [], callable|null $callable = null): $thisAdds 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);Parameters
-
stringCake\Event\EventListenerInterface|null$eventKey optional 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
implementedEventsmethods.-
array|callable$options optional Either an array of options or the callable you wish to bind to $eventKey. If an array of options, the
prioritykey 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 optional The callable function you want invoked.
Returns
$thisThrows
InvalidArgumentExceptionWhen event key is missing or callable is not an instance of Cake\Event\EventListenerInterface.
prioritisedListeners() ¶ public
prioritisedListeners(string $eventKey): arrayReturns the listeners for the specified event key indexed by priority
Parameters
-
string$eventKey Event key.
Returns
arraysetEventList() ¶ public
setEventList(Cake\Event\EventList $eventList): $thisEnables the listing of dispatched events.
Parameters
-
Cake\Event\EventList$eventList The event list object to use.
Returns
$thistrackEvents() ¶ public
trackEvents(bool $enabled): $thisEnables / disables event tracking at runtime.
Parameters
-
bool$enabled True or false to enable / disable it.
Returns
$thisunsetEventList() ¶ public
unsetEventList(): $thisDisables the listing of dispatched events.
Returns
$thisProperty Detail
$_generalManager ¶ protected static
The globally available instance, used for dispatching events attached from any scope
Type
Cake\Event\EventManager$_trackEvents ¶ protected
Enables automatic adding of events to the event list object if it is present.
Type
bool$defaultPriority ¶ public static
The default priority queue value for new, attached listeners
Type
int