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

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\RequestMatcherInterface;
  16. use Symfony\Component\HttpFoundation\RequestStack;
  17. use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
  18. use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
  19. use Symfony\Component\HttpKernel\Event\PostResponseEvent;
  20. use Symfony\Component\HttpKernel\KernelEvents;
  21. use Symfony\Component\HttpKernel\Profiler\Profiler;
  23. /**
  24.  * ProfilerListener collects data for the current request by listening to the kernel events.
  25.  *
  26.  * @author Fabien Potencier <fabien@symfony.com>
  27.  *
  28.  * @final since Symfony 4.3
  29.  */
  30. class ProfilerListener implements EventSubscriberInterface
  31. {
  32.     protected $profiler;
  33.     protected $matcher;
  34.     protected $onlyException;
  35.     protected $onlyMasterRequests;
  36.     protected $exception;
  37.     protected $profiles;
  38.     protected $requestStack;
  39.     protected $parents;
  41.     /**
  42.      * @param Profiler                     $profiler           A Profiler instance
  43.      * @param RequestStack                 $requestStack       A RequestStack instance
  44.      * @param RequestMatcherInterface|null $matcher            A RequestMatcher instance
  45.      * @param bool                         $onlyException      True if the profiler only collects data when an exception occurs, false otherwise
  46.      * @param bool                         $onlyMasterRequests True if the profiler only collects data when the request is a master request, false otherwise
  47.      */
  48.     public function __construct(Profiler $profiler, RequestStack $requestStack, RequestMatcherInterface $matcher = null, bool $onlyException = false, bool $onlyMasterRequests = false)
  49.     {
  50.         $this->profiler = $profiler;
  51.         $this->matcher = $matcher;
  52.         $this->onlyException = $onlyException;
  53.         $this->onlyMasterRequests = $onlyMasterRequests;
  54.         $this->profiles = new \SplObjectStorage();
  55.         $this->parents = new \SplObjectStorage();
  56.         $this->requestStack = $requestStack;
  57.     }
  59.     /**
  60.      * Handles the onKernelException event.
  61.      */
  62.     public function onKernelException(GetResponseForExceptionEvent $event)
  63.     {
  64.         if ($this->onlyMasterRequests && !$event->isMasterRequest()) {
  65.             return;
  66.         }
  68.         $this->exception = $event->getException();
  69.     }
  71.     /**
  72.      * Handles the onKernelResponse event.
  73.      */
  74.     public function onKernelResponse(FilterResponseEvent $event)
  75.     {
  76.         $master = $event->isMasterRequest();
  77.         if ($this->onlyMasterRequests && !$master) {
  78.             return;
  79.         }
  81.         if ($this->onlyException && null === $this->exception) {
  82.             return;
  83.         }
  85.         $request = $event->getRequest();
  86.         $exception = $this->exception;
  87.         $this->exception = null;
  89.         if (null !== $this->matcher && !$this->matcher->matches($request)) {
  90.             return;
  91.         }
  93.         if (!$profile = $this->profiler->collect($request, $event->getResponse(), $exception)) {
  94.             return;
  95.         }
  97.         $this->profiles[$request] = $profile;
  99.         $this->parents[$request] = $this->requestStack->getParentRequest();
  100.     }
  102.     public function onKernelTerminate(PostResponseEvent $event)
  103.     {
  104.         // attach children to parents
  105.         foreach ($this->profiles as $request) {
  106.             if (null !== $parentRequest = $this->parents[$request]) {
  107.                 if (isset($this->profiles[$parentRequest])) {
  108.                     $this->profiles[$parentRequest]->addChild($this->profiles[$request]);
  109.                 }
  110.             }
  111.         }
  113.         // save profiles
  114.         foreach ($this->profiles as $request) {
  115.             $this->profiler->saveProfile($this->profiles[$request]);
  116.         }
  118.         $this->profiles = new \SplObjectStorage();
  119.         $this->parents = new \SplObjectStorage();
  120.     }
  122.     public static function getSubscribedEvents()
  123.     {
  124.         return [
  125.             KernelEvents::RESPONSE => ['onKernelResponse', -100],
  126.             KernelEvents::EXCEPTION => ['onKernelException', 0],
  127.             KernelEvents::TERMINATE => ['onKernelTerminate', -1024],
  128.         ];
  129.     }
  130. }