interface EventDispatcherInterface
Same name in this branch
- 11.1.x vendor/symfony/event-dispatcher-contracts/EventDispatcherInterface.php \Symfony\Contracts\EventDispatcher\EventDispatcherInterface
- 11.1.x vendor/psr/event-dispatcher/src/EventDispatcherInterface.php \Psr\EventDispatcher\EventDispatcherInterface
The EventDispatcherInterface is the central point of Symfony's event listener system. Listeners are registered on the manager and events are dispatched through the manager.
@author Bernhard Schussek <bschussek@gmail.com>
Hierarchy
- interface \Psr\EventDispatcher\EventDispatcherInterface
- interface \Symfony\Contracts\EventDispatcher\EventDispatcherInterface extends \Psr\EventDispatcher\EventDispatcherInterface
- interface \Symfony\Component\EventDispatcher\EventDispatcherInterface extends \Symfony\Contracts\EventDispatcher\EventDispatcherInterface
- interface \Symfony\Contracts\EventDispatcher\EventDispatcherInterface extends \Psr\EventDispatcher\EventDispatcherInterface
Expanded class hierarchy of EventDispatcherInterface
All classes that implement EventDispatcherInterface
5 files declare their use of EventDispatcherInterface
- FileUploadHandler.php in core/
modules/ file/ src/ Upload/ FileUploadHandler.php - ModuleHandler.php in core/
lib/ Drupal/ Core/ Extension/ ModuleHandler.php - PackageManagerUninstallValidator.php in core/
modules/ package_manager/ src/ PackageManagerUninstallValidator.php - TraceableEventDispatcher.php in vendor/
symfony/ event-dispatcher/ Debug/ TraceableEventDispatcher.php - WrappedListener.php in vendor/
symfony/ event-dispatcher/ Debug/ WrappedListener.php
File
-
vendor/
symfony/ event-dispatcher/ EventDispatcherInterface.php, line 23
Namespace
Symfony\Component\EventDispatcherView source
interface EventDispatcherInterface extends ContractsEventDispatcherInterface {
/**
* Adds an event listener that listens on the specified events.
*
* @param int $priority The higher this value, the earlier an event
* listener will be triggered in the chain (defaults to 0)
*/
public function addListener(string $eventName, callable $listener, int $priority = 0) : void;
/**
* Adds an event subscriber.
*
* The subscriber is asked for all the events it is
* interested in and added as a listener for these events.
*/
public function addSubscriber(EventSubscriberInterface $subscriber) : void;
/**
* Removes an event listener from the specified events.
*/
public function removeListener(string $eventName, callable $listener) : void;
public function removeSubscriber(EventSubscriberInterface $subscriber) : void;
/**
* Gets the listeners of a specific event or all listeners sorted by descending priority.
*
* @return array<callable[]|callable>
*/
public function getListeners(?string $eventName = null) : array;
/**
* Gets the listener priority for a specific event.
*
* Returns null if the event or the listener does not exist.
*/
public function getListenerPriority(string $eventName, callable $listener) : ?int;
/**
* Checks whether an event has any registered listeners.
*/
public function hasListeners(?string $eventName = null) : bool;
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
EventDispatcherInterface::addListener | public | function | Adds an event listener that listens on the specified events. | 3 | |
EventDispatcherInterface::addSubscriber | public | function | Adds an event subscriber. | 3 | |
EventDispatcherInterface::dispatch | public | function | Dispatches an event to all registered listeners. | Overrides EventDispatcherInterface::dispatch | 3 |
EventDispatcherInterface::getListenerPriority | public | function | Gets the listener priority for a specific event. | 3 | |
EventDispatcherInterface::getListeners | public | function | Gets the listeners of a specific event or all listeners sorted by descending priority. | 3 | |
EventDispatcherInterface::hasListeners | public | function | Checks whether an event has any registered listeners. | 3 | |
EventDispatcherInterface::removeListener | public | function | Removes an event listener from the specified events. | 3 | |
EventDispatcherInterface::removeSubscriber | public | function | 3 |