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

  2. use Psr\EventDispatcher\StoppableEventInterface;
  3. use Symfony\Component\EventDispatcher\Debug\WrappedListener;
  5. /**
  6.  * The EventDispatcherInterface is the central point of Symfony's event listener system.
  7.  *
  8.  * Listeners are registered on the manager and events are dispatched through the
  9.  * manager.
  10.  *
  11.  * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
  12.  * @author Jonathan Wage <jonwage@gmail.com>
  13.  * @author Roman Borschel <roman@code-factory.org>
  14.  * @author Bernhard Schussek <bschussek@gmail.com>
  15.  * @author Fabien Potencier <fabien@symfony.com>
  16.  * @author Jordi Boggiano <j.boggiano@seld.be>
  17.  * @author Jordan Alliot <jordan.alliot@gmail.com>
  18.  * @author Nicolas Grekas <p@tchwork.com>
  19.  */
  20. class EventDispatcher implements EventDispatcherInterface
  21. {
  22.     private array $listeners = [];
  23.     private array $sorted = [];
  24.     private array $optimized;
  26.     public function __construct()
  27.     {
  28.         if (__CLASS__ === static::class) {
  29.             $this->optimized = [];
  30.         }
  31.     }
  33.     public function dispatch(object $event, ?string $eventName = null): object
  34.     {
  35.         $eventName ??= $event::class;
  37.         if (isset($this->optimized)) {
  38.             $listeners = $this->optimized[$eventName] ?? (empty($this->listeners[$eventName]) ? [] : $this->optimizeListeners($eventName));
  39.         } else {
  40.             $listeners = $this->getListeners($eventName);
  41.         }
  43.         if ($listeners) {
  44.             $this->callListeners($listeners, $eventName, $event);
  45.         }
  47.         return $event;
  48.     }
  50.     public function getListeners(?string $eventName = null): array
  51.     {
  52.         if (null !== $eventName) {
  53.             if (empty($this->listeners[$eventName])) {
  54.                 return [];
  55.             }
  57.             if (!isset($this->sorted[$eventName])) {
  58.                 $this->sortListeners($eventName);
  59.             }
  61.             return $this->sorted[$eventName];
  62.         }
  64.         foreach ($this->listeners as $eventName => $eventListeners) {
  65.             if (!isset($this->sorted[$eventName])) {
  66.                 $this->sortListeners($eventName);
  67.             }
  68.         }
  70.         return array_filter($this->sorted);
  71.     }
  73.     public function getListenerPriority(string $eventName, callable|array $listener): ?int
  74.     {
  75.         if (empty($this->listeners[$eventName])) {
  76.             return null;
  77.         }
  79.         if (\is_array($listener) && isset($listener[0]) && $listener[0] instanceof \Closure && 2 >= \count($listener)) {
  80.             $listener[0] = $listener[0]();
  81.             $listener[1] ??= '__invoke';
  82.         }
  84.         foreach ($this->listeners[$eventName] as $priority => &$listeners) {
  85.             foreach ($listeners as &$v) {
  86.                 if ($v !== $listener && \is_array($v) && isset($v[0]) && $v[0] instanceof \Closure && 2 >= \count($v)) {
  87.                     $v[0] = $v[0]();
  88.                     $v[1] ??= '__invoke';
  89.                 }
  90.                 if ($v === $listener || ($listener instanceof \Closure && $v == $listener)) {
  91.                     return $priority;
  92.                 }
  93.             }
  94.         }
  96.         return null;
  97.     }
  99.     public function hasListeners(?string $eventName = null): bool
  100.     {
  101.         if (null !== $eventName) {
  102.             return !empty($this->listeners[$eventName]);
  103.         }
  105.         foreach ($this->listeners as $eventListeners) {
  106.             if ($eventListeners) {
  107.                 return true;
  108.             }
  109.         }
  111.         return false;
  112.     }
  114.     public function addListener(string $eventName, callable|array $listener, int $priority = 0): void
  115.     {
  116.         $this->listeners[$eventName][$priority][] = $listener;
  117.         unset($this->sorted[$eventName], $this->optimized[$eventName]);
  118.     }
  120.     public function removeListener(string $eventName, callable|array $listener): void
  121.     {
  122.         if (empty($this->listeners[$eventName])) {
  123.             return;
  124.         }
  126.         if (\is_array($listener) && isset($listener[0]) && $listener[0] instanceof \Closure && 2 >= \count($listener)) {
  127.             $listener[0] = $listener[0]();
  128.             $listener[1] ??= '__invoke';
  129.         }
  131.         foreach ($this->listeners[$eventName] as $priority => &$listeners) {
  132.             foreach ($listeners as $k => &$v) {
  133.                 if ($v !== $listener && \is_array($v) && isset($v[0]) && $v[0] instanceof \Closure && 2 >= \count($v)) {
  134.                     $v[0] = $v[0]();
  135.                     $v[1] ??= '__invoke';
  136.                 }
  137.                 if ($v === $listener || ($listener instanceof \Closure && $v == $listener)) {
  138.                     unset($listeners[$k], $this->sorted[$eventName], $this->optimized[$eventName]);
  139.                 }
  140.             }
  142.             if (!$listeners) {
  143.                 unset($this->listeners[$eventName][$priority]);
  144.             }
  145.         }
  146.     }
  148.     public function addSubscriber(EventSubscriberInterface $subscriber): void
  149.     {
  150.         foreach ($subscriber->getSubscribedEvents() as $eventName => $params) {
  151.             if (\is_string($params)) {
  152.                 $this->addListener($eventName, [$subscriber, $params]);
  153.             } elseif (\is_string($params[0])) {
  154.                 $this->addListener($eventName, [$subscriber, $params[0]], $params[1] ?? 0);
  155.             } else {
  156.                 foreach ($params as $listener) {
  157.                     $this->addListener($eventName, [$subscriber, $listener[0]], $listener[1] ?? 0);
  158.                 }
  159.             }
  160.         }
  161.     }
  163.     public function removeSubscriber(EventSubscriberInterface $subscriber): void
  164.     {
  165.         foreach ($subscriber->getSubscribedEvents() as $eventName => $params) {
  166.             if (\is_array($params) && \is_array($params[0])) {
  167.                 foreach ($params as $listener) {
  168.                     $this->removeListener($eventName, [$subscriber, $listener[0]]);
  169.                 }
  170.             } else {
  171.                 $this->removeListener($eventName, [$subscriber, \is_string($params) ? $params : $params[0]]);
  172.             }
  173.         }
  174.     }
  176.     /**
  177.      * Triggers the listeners of an event.
  178.      *
  179.      * This method can be overridden to add functionality that is executed
  180.      * for each listener.
  181.      *
  182.      * @param callable[] $listeners The event listeners
  183.      * @param string     $eventName The name of the event to dispatch
  184.      * @param object     $event     The event object to pass to the event handlers/listeners
  185.      */
  186.     protected function callListeners(iterable $listeners, string $eventName, object $event): void
  187.     {
  188.         $stoppable = $event instanceof StoppableEventInterface;
  190.         foreach ($listeners as $listener) {
  191.             if ($stoppable && $event->isPropagationStopped()) {
  192.                 break;
  193.             }
  194.             $listener($event, $eventName, $this);
  195.         }
  196.     }
  198.     /**
  199.      * Sorts the internal list of listeners for the given event by priority.
  200.      */
  201.     private function sortListeners(string $eventName): void
  202.     {
  203.         krsort($this->listeners[$eventName]);
  204.         $this->sorted[$eventName] = [];
  206.         foreach ($this->listeners[$eventName] as &$listeners) {
  207.             foreach ($listeners as &$listener) {
  208.                 if (\is_array($listener) && isset($listener[0]) && $listener[0] instanceof \Closure && 2 >= \count($listener)) {
  209.                     $listener[0] = $listener[0]();
  210.                     $listener[1] ??= '__invoke';
  211.                 }
  212.                 $this->sorted[$eventName][] = $listener;
  213.             }
  214.         }
  215.     }
  217.     /**
  218.      * Optimizes the internal list of listeners for the given event by priority.
  219.      */
  220.     private function optimizeListeners(string $eventName): array
  221.     {
  222.         krsort($this->listeners[$eventName]);
  223.         $this->optimized[$eventName] = [];
  225.         foreach ($this->listeners[$eventName] as &$listeners) {
  226.             foreach ($listeners as &$listener) {
  227.                 $closure = &$this->optimized[$eventName][];
  228.                 if (\is_array($listener) && isset($listener[0]) && $listener[0] instanceof \Closure && 2 >= \count($listener)) {
  229.                     $closure = static function (...$args) use (&$listener, &$closure) {
  230.                         if ($listener[0] instanceof \Closure) {
  231.                             $listener[0] = $listener[0]();
  232.                             $listener[1] ??= '__invoke';
  233.                         }
  234.                         ($closure = $listener(...))(...$args);
  235.                     };
  236.                 } else {
  237.                     $closure = $listener instanceof WrappedListener ? $listener : $listener(...);
  238.                 }
  239.             }
  240.         }
  242.         return $this->optimized[$eventName];
  243.     }
  244. }