vendor/symfony/http-kernel/DataCollector/EventDataCollector.php line 63

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\HttpKernel\DataCollector;
  14. use Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpFoundation\RequestStack;
  17. use Symfony\Component\HttpFoundation\Response;
  18. use Symfony\Component\VarDumper\Cloner\Data;
  19. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  20. use Symfony\Contracts\Service\ResetInterface;
  22. /**
  23.  * @author Fabien Potencier <fabien@symfony.com>
  24.  *
  25.  * @see TraceableEventDispatcher
  26.  *
  27.  * @final
  28.  */
  29. class EventDataCollector extends DataCollector implements LateDataCollectorInterface
  30. {
  31.     private ?EventDispatcherInterface $dispatcher;
  32.     private ?RequestStack $requestStack;
  33.     private ?Request $currentRequest = null;
  35.     public function __construct(EventDispatcherInterface $dispatcher = null, RequestStack $requestStack = null)
  36.     {
  37.         $this->dispatcher = $dispatcher;
  38.         $this->requestStack = $requestStack;
  39.     }
  41.     /**
  42.      * {@inheritdoc}
  43.      */
  44.     public function collect(Request $request, Response $response, \Throwable $exception = null)
  45.     {
  46.         $this->currentRequest = $this->requestStack && $this->requestStack->getMainRequest() !== $request ? $request : null;
  47.         $this->data = [
  48.             'called_listeners' => [],
  49.             'not_called_listeners' => [],
  50.             'orphaned_events' => [],
  51.         ];
  52.     }
  54.     public function reset()
  55.     {
  56.         $this->data = [];
  58.         if ($this->dispatcher instanceof ResetInterface) {
  59.             $this->dispatcher->reset();
  60.         }
  61.     }
  63.     public function lateCollect()
  64.     {
  65.         if ($this->dispatcher instanceof TraceableEventDispatcher) {
  66.             $this->setCalledListeners($this->dispatcher->getCalledListeners($this->currentRequest));
  67.             $this->setNotCalledListeners($this->dispatcher->getNotCalledListeners($this->currentRequest));
  68.             $this->setOrphanedEvents($this->dispatcher->getOrphanedEvents($this->currentRequest));
  69.         }
  71.         $this->data = $this->cloneVar($this->data);
  72.     }
  74.     /**
  75.      * @see TraceableEventDispatcher
  76.      */
  77.     public function setCalledListeners(array $listeners)
  78.     {
  79.         $this->data['called_listeners'] = $listeners;
  80.     }
  82.     /**
  83.      * @see TraceableEventDispatcher
  84.      */
  85.     public function getCalledListeners(): array|Data
  86.     {
  87.         return $this->data['called_listeners'];
  88.     }
  90.     /**
  91.      * @see TraceableEventDispatcher
  92.      */
  93.     public function setNotCalledListeners(array $listeners)
  94.     {
  95.         $this->data['not_called_listeners'] = $listeners;
  96.     }
  98.     /**
  99.      * @see TraceableEventDispatcher
  100.      */
  101.     public function getNotCalledListeners(): array|Data
  102.     {
  103.         return $this->data['not_called_listeners'];
  104.     }
  106.     /**
  107.      * @param array $events An array of orphaned events
  108.      *
  109.      * @see TraceableEventDispatcher
  110.      */
  111.     public function setOrphanedEvents(array $events)
  112.     {
  113.         $this->data['orphaned_events'] = $events;
  114.     }
  116.     /**
  117.      * @see TraceableEventDispatcher
  118.      */
  119.     public function getOrphanedEvents(): array|Data
  120.     {
  121.         return $this->data['orphaned_events'];
  122.     }
  124.     /**
  125.      * {@inheritdoc}
  126.      */
  127.     public function getName(): string
  128.     {
  129.         return 'events';
  130.     }
  131. }