vendor/jms/serializer/src/EventDispatcher/EventDispatcher.php line 112

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace JMS\Serializer\EventDispatcher;
  7. use JMS\Serializer\Exception\InvalidArgumentException;
  9. /**
  10.  * Light-weight event dispatcher.
  11.  *
  12.  * This implementation focuses primarily on performance, and dispatching
  13.  * events for certain classes. It is not a general purpose event dispatcher.
  14.  *
  15.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  16.  */
  17. class EventDispatcher implements EventDispatcherInterface
  18. {
  19.     /**
  20.      * @var array
  21.      */
  22.     private $listeners = [];
  24.     /**
  25.      * ClassListeners cache
  26.      *
  27.      * @var array
  28.      */
  29.     private $classListeners = [];
  31.     public static function getDefaultMethodName(string $eventName): string
  32.     {
  33.         return 'on' . str_replace(['_', '.'], '', $eventName);
  34.     }
  36.     /**
  37.      * Sets the listeners.
  38.      *
  39.      * @param array $listeners
  40.      */
  41.     public function setListeners(array $listeners): void
  42.     {
  43.         $this->listeners = $listeners;
  44.         $this->classListeners = [];
  45.     }
  47.     /**
  48.      * @internal Used for profiling
  49.      */
  50.     public function getListeners(): array
  51.     {
  52.         return $this->listeners;
  53.     }
  55.     /**
  56.      * {@inheritdoc}
  57.      */
  58.     public function addListener(string $eventName, $callable, ?string $class = null, ?string $format = null, ?string $interface = null): void
  59.     {
  60.         $this->listeners[$eventName][] = [$callable, $class, $format, $interface];
  61.         unset($this->classListeners[$eventName]);
  62.     }
  64.     public function addSubscriber(EventSubscriberInterface $subscriber): void
  65.     {
  66.         foreach ($subscriber->getSubscribedEvents() as $eventData) {
  67.             if (!isset($eventData['event'])) {
  68.                 throw new InvalidArgumentException(sprintf('Each event must have a "event" key.'));
  69.             }
  71.             $method = $eventData['method'] ?? self::getDefaultMethodName($eventData['event']);
  72.             $class = $eventData['class'] ?? null;
  73.             $format = $eventData['format'] ?? null;
  74.             $interface = $eventData['interface'] ?? null;
  75.             $this->listeners[$eventData['event']][] = [[$subscriber, $method], $class, $format, $interface];
  76.             unset($this->classListeners[$eventData['event']]);
  77.         }
  78.     }
  80.     public function hasListeners(string $eventName, string $class, string $format): bool
  81.     {
  82.         if (!isset($this->listeners[$eventName])) {
  83.             return false;
  84.         }
  86.         if (!isset($this->classListeners[$eventName][$class][$format])) {
  87.             $this->classListeners[$eventName][$class][$format] = $this->initializeListeners($eventName, $class, $format);
  88.         }
  90.         return !!$this->classListeners[$eventName][$class][$format];
  91.     }
  93.     public function dispatch(string $eventName, string $class, string $format, Event $event): void
  94.     {
  95.         if (!isset($this->listeners[$eventName])) {
  96.             return;
  97.         }
  99.         $object = $event instanceof ObjectEvent ? $event->getObject() : null;
  100.         $realClass = is_object($object) ? get_class($object) : '';
  101.         $objectClass = $realClass !== $class ? $realClass . $class : $class;
  103.         if (!isset($this->classListeners[$eventName][$objectClass][$format])) {
  104.             $this->classListeners[$eventName][$objectClass][$format] = $this->initializeListeners($eventName, $class, $format);
  105.         }
  107.         foreach ($this->classListeners[$eventName][$objectClass][$format] as $listener) {
  108.             if (!empty($listener[3]) && !($object instanceof $listener[3])) {
  109.                 continue;
  110.             }
  112.             \call_user_func($listener[0], $event, $eventName, $class, $format, $this);
  114.             if ($event->isPropagationStopped()) {
  115.                 break;
  116.             }
  117.         }
  118.     }
  120.     /**
  121.      * @return array An array of listeners
  122.      */
  123.     protected function initializeListeners(string $eventName, string $loweredClass, string $format): array
  124.     {
  125.         $listeners = [];
  126.         foreach ($this->listeners[$eventName] as $listener) {
  127.             if (null !== $listener[1] && $loweredClass !== $listener[1]) {
  128.                 continue;
  129.             }
  131.             if (null !== $listener[2] && $format !== $listener[2]) {
  132.                 continue;
  133.             }
  135.             $listeners[] = $listener;
  136.         }
  138.         return $listeners;
  139.     }
  140. }