vendor/symfony/event-dispatcher/Debug/WrappedListener.php line 126

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <[email protected]>
  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\Debug;
  14. use Psr\EventDispatcher\StoppableEventInterface;
  15. use Symfony\Component\EventDispatcher\Event;
  16. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  17. use Symfony\Component\EventDispatcher\LegacyEventProxy;
  18. use Symfony\Component\Stopwatch\Stopwatch;
  19. use Symfony\Component\VarDumper\Caster\ClassStub;
  20. use Symfony\Contracts\EventDispatcher\Event as ContractsEvent;
  22. /**
  23.  * @author Fabien Potencier <[email protected]>
  24.  *
  25.  * @final since Symfony 4.3: the "Event" type-hint on __invoke() will be replaced by "object" in 5.0
  26.  */
  27. class WrappedListener
  28. {
  29.     private $listener;
  30.     private $optimizedListener;
  31.     private $name;
  32.     private $called;
  33.     private $stoppedPropagation;
  34.     private $stopwatch;
  35.     private $dispatcher;
  36.     private $pretty;
  37.     private $stub;
  38.     private $priority;
  39.     private static $hasClassStub;
  41.     public function __construct($listener, ?string $name, Stopwatch $stopwatch, EventDispatcherInterface $dispatcher = null)
  42.     {
  43.         $this->listener = $listener;
  44.         $this->optimizedListener = $listener instanceof \Closure ? $listener : (\is_callable($listener) ? \Closure::fromCallable($listener) : null);
  45.         $this->stopwatch = $stopwatch;
  46.         $this->dispatcher = $dispatcher;
  47.         $this->called = false;
  48.         $this->stoppedPropagation = false;
  50.         if (\is_array($listener)) {
  51.             $this->name = \is_object($listener[0]) ? \get_class($listener[0]) : $listener[0];
  52.             $this->pretty = $this->name.'::'.$listener[1];
  53.         } elseif ($listener instanceof \Closure) {
  54.             $r = new \ReflectionFunction($listener);
  55.             if (str_contains($r->name, '{closure}')) {
  56.                 $this->pretty = $this->name = 'closure';
  57.             } elseif ($class = $r->getClosureScopeClass()) {
  58.                 $this->name = $class->name;
  59.                 $this->pretty = $this->name.'::'.$r->name;
  60.             } else {
  61.                 $this->pretty = $this->name = $r->name;
  62.             }
  63.         } elseif (\is_string($listener)) {
  64.             $this->pretty = $this->name = $listener;
  65.         } else {
  66.             $this->name = \get_class($listener);
  67.             $this->pretty = $this->name.'::__invoke';
  68.         }
  70.         if (null !== $name) {
  71.             $this->name = $name;
  72.         }
  74.         if (null === self::$hasClassStub) {
  75.             self::$hasClassStub = class_exists(ClassStub::class);
  76.         }
  77.     }
  79.     public function getWrappedListener()
  80.     {
  81.         return $this->listener;
  82.     }
  84.     public function wasCalled()
  85.     {
  86.         return $this->called;
  87.     }
  89.     public function stoppedPropagation()
  90.     {
  91.         return $this->stoppedPropagation;
  92.     }
  94.     public function getPretty()
  95.     {
  96.         return $this->pretty;
  97.     }
  99.     public function getInfo($eventName)
  100.     {
  101.         if (null === $this->stub) {
  102.             $this->stub = self::$hasClassStub ? new ClassStub($this->pretty.'()', $this->listener) : $this->pretty.'()';
  103.         }
  105.         return [
  106.             'event' => $eventName,
  107.             'priority' => null !== $this->priority ? $this->priority : (null !== $this->dispatcher ? $this->dispatcher->getListenerPriority($eventName, $this->listener) : null),
  108.             'pretty' => $this->pretty,
  109.             'stub' => $this->stub,
  110.         ];
  111.     }
  113.     public function __invoke(Event $event, $eventName, EventDispatcherInterface $dispatcher)
  114.     {
  115.         if ($event instanceof LegacyEventProxy) {
  116.             $event = $event->getEvent();
  117.         }
  119.         $dispatcher = $this->dispatcher ?: $dispatcher;
  121.         $this->called = true;
  122.         $this->priority = $dispatcher->getListenerPriority($eventName, $this->listener);
  124.         $e = $this->stopwatch->start($this->name, 'event_listener');
  126.         ($this->optimizedListener ?? $this->listener)($event, $eventName, $dispatcher);
  128.         if ($e->isStarted()) {
  129.             $e->stop();
  130.         }
  132.         if (($event instanceof Event || $event instanceof ContractsEvent || $event instanceof StoppableEventInterface) && $event->isPropagationStopped()) {
  133.             $this->stoppedPropagation = true;
  134.         }
  135.     }
  136. }