1. 8.5.x vendor/symfony/event-dispatcher/EventDispatcherInterface.php EventDispatcherInterface
  2. 8.0.x vendor/symfony/event-dispatcher/EventDispatcherInterface.php EventDispatcherInterface
  3. 8.1.x vendor/symfony/event-dispatcher/EventDispatcherInterface.php EventDispatcherInterface
  4. 8.2.x vendor/symfony/event-dispatcher/EventDispatcherInterface.php EventDispatcherInterface
  5. 8.3.x vendor/symfony/event-dispatcher/EventDispatcherInterface.php EventDispatcherInterface
  6. 8.4.x vendor/symfony/event-dispatcher/EventDispatcherInterface.php EventDispatcherInterface
  7. 8.6.x vendor/symfony/event-dispatcher/EventDispatcherInterface.php 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

Expanded class hierarchy of EventDispatcherInterface

All classes that implement EventDispatcherInterface

30 files declare their use of EventDispatcherInterface
Application.php in vendor/symfony/console/Application.php
BigPipe.php in core/modules/big_pipe/src/Render/BigPipe.php
Config.php in core/lib/Drupal/Core/Config/Config.php
ConfigFactory.php in core/lib/Drupal/Core/Config/ConfigFactory.php
ConfigImporter.php in core/lib/Drupal/Core/Config/ConfigImporter.php

... See full list

File

vendor/symfony/event-dispatcher/EventDispatcherInterface.php, line 21

Namespace

Symfony\Component\EventDispatcher
View source
interface EventDispatcherInterface {

  /**
   * Dispatches an event to all registered listeners.
   *
   * @param string $eventName The name of the event to dispatch. The name of
   *                          the event is the name of the method that is
   *                          invoked on listeners.
   * @param Event  $event     The event to pass to the event handlers/listeners
   *                          If not supplied, an empty Event instance is created.
   *
   * @return Event
   */
  public function dispatch($eventName, Event $event = null);

  /**
   * Adds an event listener that listens on the specified events.
   *
   * @param string   $eventName The event to listen on
   * @param callable $listener  The listener
   * @param int      $priority  The higher this value, the earlier an event
   *                            listener will be triggered in the chain (defaults to 0)
   */
  public function addListener($eventName, $listener, $priority = 0);

  /**
   * Adds an event subscriber.
   *
   * The subscriber is asked for all the events he is
   * interested in and added as a listener for these events.
   *
   * @param EventSubscriberInterface $subscriber The subscriber
   */
  public function addSubscriber(EventSubscriberInterface $subscriber);

  /**
   * Removes an event listener from the specified events.
   *
   * @param string   $eventName The event to remove a listener from
   * @param callable $listener  The listener to remove
   */
  public function removeListener($eventName, $listener);

  /**
   * Removes an event subscriber.
   *
   * @param EventSubscriberInterface $subscriber The subscriber
   */
  public function removeSubscriber(EventSubscriberInterface $subscriber);

  /**
   * Gets the listeners of a specific event or all listeners sorted by descending priority.
   *
   * @param string $eventName The name of the event
   *
   * @return array The event listeners for the specified event, or all event listeners by event name
   */
  public function getListeners($eventName = null);

  /**
   * Checks whether an event has any registered listeners.
   *
   * @param string $eventName The name of the event
   *
   * @return bool true if the specified event has any listeners, false otherwise
   */
  public function hasListeners($eventName = null);

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
EventDispatcherInterface::addListener public function Adds an event listener that listens on the specified events.
EventDispatcherInterface::addSubscriber public function Adds an event subscriber.
EventDispatcherInterface::dispatch public function Dispatches an event to all registered listeners.
EventDispatcherInterface::getListeners public function Gets the listeners of a specific event or all listeners sorted by descending priority.
EventDispatcherInterface::hasListeners public function Checks whether an event has any registered listeners.
EventDispatcherInterface::removeListener public function Removes an event listener from the specified events.
EventDispatcherInterface::removeSubscriber public function Removes an event subscriber.