vendor/symfony/event-dispatcher/EventDispatcher.php line 90

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\EventDispatcher;
  14. use Psr\EventDispatcher\StoppableEventInterface;
  15. use Symfony\Component\EventDispatcher\Debug\WrappedListener;
  16. use Symfony\Contracts\EventDispatcher\Event as ContractsEvent;
  18. /**
  19.  * The EventDispatcherInterface is the central point of Symfony's event listener system.
  20.  *
  21.  * Listeners are registered on the manager and events are dispatched through the
  22.  * manager.
  23.  *
  24.  * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
  25.  * @author Jonathan Wage <jonwage@gmail.com>
  26.  * @author Roman Borschel <roman@code-factory.org>
  27.  * @author Bernhard Schussek <bschussek@gmail.com>
  28.  * @author Fabien Potencier <fabien@symfony.com>
  29.  * @author Jordi Boggiano <j.boggiano@seld.be>
  30.  * @author Jordan Alliot <jordan.alliot@gmail.com>
  31.  * @author Nicolas Grekas <p@tchwork.com>
  32.  */
  33. class EventDispatcher implements EventDispatcherInterface
  34. {
  35.     private $listeners = [];
  36.     private $sorted = [];
  37.     private $optimized;
  39.     public function __construct()
  40.     {
  41.         if (__CLASS__ === static::class) {
  42.             $this->optimized = [];
  43.         }
  44.     }
  46.     /**
  47.      * {@inheritdoc}
  48.      *
  49.      * @param string|null $eventName
  50.      */
  51.     public function dispatch($event/*, string $eventName = null*/)
  52.     {
  53.         $eventName = 1 < \func_num_args() ? func_get_arg(1) : null;
  55.         if (\is_object($event)) {
  56.             $eventName = $eventName ?? \get_class($event);
  57.         } elseif (\is_string($event) && (null === $eventName || $eventName instanceof ContractsEvent || $eventName instanceof Event)) {
  58.             @trigger_error(sprintf('Calling the "%s::dispatch()" method with the event name as the first argument is deprecated since Symfony 4.3, pass it as the second argument and provide the event object as the first argument instead.', EventDispatcherInterface::class), \E_USER_DEPRECATED);
  59.             $swap = $event;
  60.             $event = $eventName ?? new Event();
  61.             $eventName = $swap;
  62.         } else {
  63.             throw new \TypeError(sprintf('Argument 1 passed to "%s::dispatch()" must be an object, "%s" given.', EventDispatcherInterface::class, \is_object($event) ? \get_class($event) : \gettype($event)));
  64.         }
  66.         if (null !== $this->optimized && null !== $eventName) {
  67.             $listeners = $this->optimized[$eventName] ?? (empty($this->listeners[$eventName]) ? [] : $this->optimizeListeners($eventName));
  68.         } else {
  69.             $listeners = $this->getListeners($eventName);
  70.         }
  72.         if ($listeners) {
  73.             $this->callListeners($listeners, $eventName, $event);
  74.         }
  76.         return $event;
  77.     }
  79.     /**
  80.      * {@inheritdoc}
  81.      */
  82.     public function getListeners($eventName = null)
  83.     {
  84.         if (null !== $eventName) {
  85.             if (empty($this->listeners[$eventName])) {
  86.                 return [];
  87.             }
  89.             if (!isset($this->sorted[$eventName])) {
  90.                 $this->sortListeners($eventName);
  91.             }
  93.             return $this->sorted[$eventName];
  94.         }
  96.         foreach ($this->listeners as $eventName => $eventListeners) {
  97.             if (!isset($this->sorted[$eventName])) {
  98.                 $this->sortListeners($eventName);
  99.             }
  100.         }
  102.         return array_filter($this->sorted);
  103.     }
  105.     /**
  106.      * {@inheritdoc}
  107.      */
  108.     public function getListenerPriority($eventName, $listener)
  109.     {
  110.         if (empty($this->listeners[$eventName])) {
  111.             return null;
  112.         }
  114.         if (\is_array($listener) && isset($listener[0]) && $listener[0] instanceof \Closure && 2 >= \count($listener)) {
  115.             $listener[0] = $listener[0]();
  116.             $listener[1] = $listener[1] ?? '__invoke';
  117.         }
  119.         foreach ($this->listeners[$eventName] as $priority => &$listeners) {
  120.             foreach ($listeners as &$v) {
  121.                 if ($v !== $listener && \is_array($v) && isset($v[0]) && $v[0] instanceof \Closure && 2 >= \count($v)) {
  122.                     $v[0] = $v[0]();
  123.                     $v[1] = $v[1] ?? '__invoke';
  124.                 }
  125.                 if ($v === $listener) {
  126.                     return $priority;
  127.                 }
  128.             }
  129.         }
  131.         return null;
  132.     }
  134.     /**
  135.      * {@inheritdoc}
  136.      */
  137.     public function hasListeners($eventName = null)
  138.     {
  139.         if (null !== $eventName) {
  140.             return !empty($this->listeners[$eventName]);
  141.         }
  143.         foreach ($this->listeners as $eventListeners) {
  144.             if ($eventListeners) {
  145.                 return true;
  146.             }
  147.         }
  149.         return false;
  150.     }
  152.     /**
  153.      * {@inheritdoc}
  154.      */
  155.     public function addListener($eventName, $listener, $priority = 0)
  156.     {
  157.         $this->listeners[$eventName][$priority][] = $listener;
  158.         unset($this->sorted[$eventName], $this->optimized[$eventName]);
  159.     }
  161.     /**
  162.      * {@inheritdoc}
  163.      */
  164.     public function removeListener($eventName, $listener)
  165.     {
  166.         if (empty($this->listeners[$eventName])) {
  167.             return;
  168.         }
  170.         if (\is_array($listener) && isset($listener[0]) && $listener[0] instanceof \Closure && 2 >= \count($listener)) {
  171.             $listener[0] = $listener[0]();
  172.             $listener[1] = $listener[1] ?? '__invoke';
  173.         }
  175.         foreach ($this->listeners[$eventName] as $priority => &$listeners) {
  176.             foreach ($listeners as $k => &$v) {
  177.                 if ($v !== $listener && \is_array($v) && isset($v[0]) && $v[0] instanceof \Closure && 2 >= \count($v)) {
  178.                     $v[0] = $v[0]();
  179.                     $v[1] = $v[1] ?? '__invoke';
  180.                 }
  181.                 if ($v === $listener) {
  182.                     unset($listeners[$k], $this->sorted[$eventName], $this->optimized[$eventName]);
  183.                 }
  184.             }
  186.             if (!$listeners) {
  187.                 unset($this->listeners[$eventName][$priority]);
  188.             }
  189.         }
  190.     }
  192.     /**
  193.      * {@inheritdoc}
  194.      */
  195.     public function addSubscriber(EventSubscriberInterface $subscriber)
  196.     {
  197.         foreach ($subscriber->getSubscribedEvents() as $eventName => $params) {
  198.             if (\is_string($params)) {
  199.                 $this->addListener($eventName, [$subscriber, $params]);
  200.             } elseif (\is_string($params[0])) {
  201.                 $this->addListener($eventName, [$subscriber, $params[0]], $params[1] ?? 0);
  202.             } else {
  203.                 foreach ($params as $listener) {
  204.                     $this->addListener($eventName, [$subscriber, $listener[0]], $listener[1] ?? 0);
  205.                 }
  206.             }
  207.         }
  208.     }
  210.     /**
  211.      * {@inheritdoc}
  212.      */
  213.     public function removeSubscriber(EventSubscriberInterface $subscriber)
  214.     {
  215.         foreach ($subscriber->getSubscribedEvents() as $eventName => $params) {
  216.             if (\is_array($params) && \is_array($params[0])) {
  217.                 foreach ($params as $listener) {
  218.                     $this->removeListener($eventName, [$subscriber, $listener[0]]);
  219.                 }
  220.             } else {
  221.                 $this->removeListener($eventName, [$subscriber, \is_string($params) ? $params : $params[0]]);
  222.             }
  223.         }
  224.     }
  226.     /**
  227.      * Triggers the listeners of an event.
  228.      *
  229.      * This method can be overridden to add functionality that is executed
  230.      * for each listener.
  231.      *
  232.      * @param callable[] $listeners The event listeners
  233.      * @param string     $eventName The name of the event to dispatch
  234.      * @param object     $event     The event object to pass to the event handlers/listeners
  235.      */
  236.     protected function callListeners(iterable $listeners, string $eventName, $event)
  237.     {
  238.         if ($event instanceof Event) {
  239.             $this->doDispatch($listeners, $eventName, $event);
  241.             return;
  242.         }
  244.         $stoppable = $event instanceof ContractsEvent || $event instanceof StoppableEventInterface;
  246.         foreach ($listeners as $listener) {
  247.             if ($stoppable && $event->isPropagationStopped()) {
  248.                 break;
  249.             }
  250.             // @deprecated: the ternary operator is part of a BC layer and should be removed in 5.0
  251.             $listener($listener instanceof WrappedListener ? new LegacyEventProxy($event) : $event, $eventName, $this);
  252.         }
  253.     }
  255.     /**
  256.      * @deprecated since Symfony 4.3, use callListeners() instead
  257.      */
  258.     protected function doDispatch($listeners, $eventName, Event $event)
  259.     {
  260.         foreach ($listeners as $listener) {
  261.             if ($event->isPropagationStopped()) {
  262.                 break;
  263.             }
  264.             $listener($event, $eventName, $this);
  265.         }
  266.     }
  268.     /**
  269.      * Sorts the internal list of listeners for the given event by priority.
  270.      */
  271.     private function sortListeners(string $eventName)
  272.     {
  273.         krsort($this->listeners[$eventName]);
  274.         $this->sorted[$eventName] = [];
  276.         foreach ($this->listeners[$eventName] as &$listeners) {
  277.             foreach ($listeners as $k => &$listener) {
  278.                 if (\is_array($listener) && isset($listener[0]) && $listener[0] instanceof \Closure && 2 >= \count($listener)) {
  279.                     $listener[0] = $listener[0]();
  280.                     $listener[1] = $listener[1] ?? '__invoke';
  281.                 }
  282.                 $this->sorted[$eventName][] = $listener;
  283.             }
  284.         }
  285.     }
  287.     /**
  288.      * Optimizes the internal list of listeners for the given event by priority.
  289.      */
  290.     private function optimizeListeners(string $eventName): array
  291.     {
  292.         krsort($this->listeners[$eventName]);
  293.         $this->optimized[$eventName] = [];
  295.         foreach ($this->listeners[$eventName] as &$listeners) {
  296.             foreach ($listeners as &$listener) {
  297.                 $closure = &$this->optimized[$eventName][];
  298.                 if (\is_array($listener) && isset($listener[0]) && $listener[0] instanceof \Closure && 2 >= \count($listener)) {
  299.                     $closure = static function (...$args) use (&$listener, &$closure) {
  300.                         if ($listener[0] instanceof \Closure) {
  301.                             $listener[0] = $listener[0]();
  302.                             $listener[1] = $listener[1] ?? '__invoke';
  303.                         }
  304.                         ($closure = \Closure::fromCallable($listener))(...$args);
  305.                     };
  306.                 } else {
  307.                     $closure = $listener instanceof \Closure || $listener instanceof WrappedListener ? $listener : \Closure::fromCallable($listener);
  308.                 }
  309.             }
  310.         }
  312.         return $this->optimized[$eventName];
  313.     }
  314. }