class EventDispatcher in Zircon Profile 8

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 Guilherme Blanco <[e-mail]> @author Jonathan Wage <[e-mail]> @author Roman Borschel <[e-mail]> @author Bernhard Schussek <[e-mail]> @author Fabien Potencier <[e-mail]> @author Jordi Boggiano <[e-mail]> @author Jordan Alliot <[e-mail]>

Hierarchy

• class \Symfony\Component\EventDispatcher\EventDispatcher implements EventDispatcherInterface

18 files declare their use of EventDispatcher

AbstractEventDispatcherTest.php in vendor/symfony/event-dispatcher/Tests/AbstractEventDispatcherTest.php

ApplicationTest.php in vendor/symfony/console/Tests/ApplicationTest.php

ContainerAwareHttpKernelTest.php in vendor/symfony/http-kernel/Tests/DependencyInjection/ContainerAwareHttpKernelTest.php

DebugHandlersListenerTest.php in vendor/symfony/http-kernel/Tests/EventListener/DebugHandlersListenerTest.php

EventDispatcherTest.php in vendor/symfony/event-dispatcher/Tests/EventDispatcherTest.php

... See full list

File

vendor/symfony/event-dispatcher/EventDispatcher.php, line 28

Namespace

Symfony\Component\EventDispatcher

class EventDispatcher implements EventDispatcherInterface {
  private $listeners = array();
  private $sorted = array();

  /**
   * {@inheritdoc}
   */
  public function dispatch($eventName, Event $event = null) {
    if (null === $event) {
      $event = new Event();
    }
    $event
      ->setDispatcher($this);
    $event
      ->setName($eventName);
    if ($listeners = $this
      ->getListeners($eventName)) {
      $this
        ->doDispatch($listeners, $eventName, $event);
    }
    return $event;
  }

  /**
   * {@inheritdoc}
   */
  public function getListeners($eventName = null) {
    if (null !== $eventName) {
      if (!isset($this->listeners[$eventName])) {
        return array();
      }
      if (!isset($this->sorted[$eventName])) {
        $this
          ->sortListeners($eventName);
      }
      return $this->sorted[$eventName];
    }
    foreach ($this->listeners as $eventName => $eventListeners) {
      if (!isset($this->sorted[$eventName])) {
        $this
          ->sortListeners($eventName);
      }
    }
    return array_filter($this->sorted);
  }

  /**
   * {@inheritdoc}
   */
  public function hasListeners($eventName = null) {
    return (bool) count($this
      ->getListeners($eventName));
  }

  /**
   * {@inheritdoc}
   */
  public function addListener($eventName, $listener, $priority = 0) {
    $this->listeners[$eventName][$priority][] = $listener;
    unset($this->sorted[$eventName]);
  }

  /**
   * {@inheritdoc}
   */
  public function removeListener($eventName, $listener) {
    if (!isset($this->listeners[$eventName])) {
      return;
    }
    foreach ($this->listeners[$eventName] as $priority => $listeners) {
      if (false !== ($key = array_search($listener, $listeners, true))) {
        unset($this->listeners[$eventName][$priority][$key], $this->sorted[$eventName]);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function addSubscriber(EventSubscriberInterface $subscriber) {
    foreach ($subscriber
      ->getSubscribedEvents() as $eventName => $params) {
      if (is_string($params)) {
        $this
          ->addListener($eventName, array(
          $subscriber,
          $params,
        ));
      }
      elseif (is_string($params[0])) {
        $this
          ->addListener($eventName, array(
          $subscriber,
          $params[0],
        ), isset($params[1]) ? $params[1] : 0);
      }
      else {
        foreach ($params as $listener) {
          $this
            ->addListener($eventName, array(
            $subscriber,
            $listener[0],
          ), isset($listener[1]) ? $listener[1] : 0);
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function removeSubscriber(EventSubscriberInterface $subscriber) {
    foreach ($subscriber
      ->getSubscribedEvents() as $eventName => $params) {
      if (is_array($params) && is_array($params[0])) {
        foreach ($params as $listener) {
          $this
            ->removeListener($eventName, array(
            $subscriber,
            $listener[0],
          ));
        }
      }
      else {
        $this
          ->removeListener($eventName, array(
          $subscriber,
          is_string($params) ? $params : $params[0],
        ));
      }
    }
  }

  /**
   * Triggers the listeners of an event.
   *
   * This method can be overridden to add functionality that is executed
   * for each listener.
   *
   * @param callable[] $listeners The event listeners.
   * @param string     $eventName The name of the event to dispatch.
   * @param Event      $event     The event object to pass to the event handlers/listeners.
   */
  protected function doDispatch($listeners, $eventName, Event $event) {
    foreach ($listeners as $listener) {
      call_user_func($listener, $event, $eventName, $this);
      if ($event
        ->isPropagationStopped()) {
        break;
      }
    }
  }

  /**
   * Sorts the internal list of listeners for the given event by priority.
   *
   * @param string $eventName The name of the event.
   */
  private function sortListeners($eventName) {
    $this->sorted[$eventName] = array();
    krsort($this->listeners[$eventName]);
    $this->sorted[$eventName] = call_user_func_array('array_merge', $this->listeners[$eventName]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EventDispatcher::$listeners	private	property		1
EventDispatcher::$sorted	private	property
EventDispatcher::addListener	public	function	Adds an event listener that listens on the specified events. Overrides EventDispatcherInterface::addListener
EventDispatcher::addSubscriber	public	function	Adds an event subscriber. Overrides EventDispatcherInterface::addSubscriber
EventDispatcher::dispatch	public	function	Dispatches an event to all registered listeners. Overrides EventDispatcherInterface::dispatch
EventDispatcher::doDispatch	protected	function	Triggers the listeners of an event.
EventDispatcher::getListeners	public	function	Gets the listeners of a specific event or all listeners sorted by descending priority. Overrides EventDispatcherInterface::getListeners	1
EventDispatcher::hasListeners	public	function	Checks whether an event has any registered listeners. Overrides EventDispatcherInterface::hasListeners	1
EventDispatcher::removeListener	public	function	Removes an event listener from the specified events. Overrides EventDispatcherInterface::removeListener	1
EventDispatcher::removeSubscriber	public	function	Removes an event subscriber. Overrides EventDispatcherInterface::removeSubscriber
EventDispatcher::sortListeners	private	function	Sorts the internal list of listeners for the given event by priority.