vendor/symfony/http-kernel/EventListener/ProfilerListener.php line 77

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\EventListener;
  14. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpFoundation\RequestMatcherInterface;
  17. use Symfony\Component\HttpFoundation\RequestStack;
  18. use Symfony\Component\HttpKernel\Event\ExceptionEvent;
  19. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  20. use Symfony\Component\HttpKernel\Event\TerminateEvent;
  21. use Symfony\Component\HttpKernel\KernelEvents;
  22. use Symfony\Component\HttpKernel\Profiler\Profile;
  23. use Symfony\Component\HttpKernel\Profiler\Profiler;
  25. /**
  26.  * ProfilerListener collects data for the current request by listening to the kernel events.
  27.  *
  28.  * @author Fabien Potencier <fabien@symfony.com>
  29.  *
  30.  * @final
  31.  */
  32. class ProfilerListener implements EventSubscriberInterface
  33. {
  34.     private Profiler $profiler;
  35.     private ?RequestMatcherInterface $matcher;
  36.     private bool $onlyException;
  37.     private bool $onlyMainRequests;
  38.     private ?\Throwable $exception = null;
  39.     /** @var \SplObjectStorage<Request, Profile> */
  40.     private \SplObjectStorage $profiles;
  41.     private RequestStack $requestStack;
  42.     private ?string $collectParameter;
  43.     /** @var \SplObjectStorage<Request, Request|null> */
  44.     private \SplObjectStorage $parents;
  46.     /**
  47.      * @param bool $onlyException    True if the profiler only collects data when an exception occurs, false otherwise
  48.      * @param bool $onlyMainRequests True if the profiler only collects data when the request is the main request, false otherwise
  49.      */
  50.     public function __construct(Profiler $profiler, RequestStack $requestStack, RequestMatcherInterface $matcher = null, bool $onlyException = false, bool $onlyMainRequests = false, string $collectParameter = null)
  51.     {
  52.         $this->profiler = $profiler;
  53.         $this->matcher = $matcher;
  54.         $this->onlyException = $onlyException;
  55.         $this->onlyMainRequests = $onlyMainRequests;
  56.         $this->profiles = new \SplObjectStorage();
  57.         $this->parents = new \SplObjectStorage();
  58.         $this->requestStack = $requestStack;
  59.         $this->collectParameter = $collectParameter;
  60.     }
  62.     /**
  63.      * Handles the onKernelException event.
  64.      */
  65.     public function onKernelException(ExceptionEvent $event)
  66.     {
  67.         if ($this->onlyMainRequests && !$event->isMainRequest()) {
  68.             return;
  69.         }
  71.         $this->exception = $event->getThrowable();
  72.     }
  74.     /**
  75.      * Handles the onKernelResponse event.
  76.      */
  77.     public function onKernelResponse(ResponseEvent $event)
  78.     {
  79.         if ($this->onlyMainRequests && !$event->isMainRequest()) {
  80.             return;
  81.         }
  83.         if ($this->onlyException && null === $this->exception) {
  84.             return;
  85.         }
  87.         $request = $event->getRequest();
  88.         if (null !== $this->collectParameter && null !== $collectParameterValue = $request->get($this->collectParameter)) {
  89.             true === $collectParameterValue || filter_var($collectParameterValue, \FILTER_VALIDATE_BOOLEAN) ? $this->profiler->enable() : $this->profiler->disable();
  90.         }
  92.         $exception = $this->exception;
  93.         $this->exception = null;
  95.         if (null !== $this->matcher && !$this->matcher->matches($request)) {
  96.             return;
  97.         }
  99.         if (!$profile = $this->profiler->collect($request, $event->getResponse(), $exception)) {
  100.             return;
  101.         }
  103.         $this->profiles[$request] = $profile;
  105.         $this->parents[$request] = $this->requestStack->getParentRequest();
  106.     }
  108.     public function onKernelTerminate(TerminateEvent $event)
  109.     {
  110.         // attach children to parents
  111.         foreach ($this->profiles as $request) {
  112.             if (null !== $parentRequest = $this->parents[$request]) {
  113.                 if (isset($this->profiles[$parentRequest])) {
  114.                     $this->profiles[$parentRequest]->addChild($this->profiles[$request]);
  115.                 }
  116.             }
  117.         }
  119.         // save profiles
  120.         foreach ($this->profiles as $request) {
  121.             $this->profiler->saveProfile($this->profiles[$request]);
  122.         }
  124.         $this->profiles = new \SplObjectStorage();
  125.         $this->parents = new \SplObjectStorage();
  126.     }
  128.     public static function getSubscribedEvents(): array
  129.     {
  130.         return [
  131.             KernelEvents::RESPONSE => ['onKernelResponse', -100],
  132.             KernelEvents::EXCEPTION => ['onKernelException', 0],
  133.             KernelEvents::TERMINATE => ['onKernelTerminate', -1024],
  134.         ];
  135.     }
  136. }