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

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. class ProfilerListener implements EventSubscriberInterface {
  30.     protected $profiler;
  31.     protected $matcher;
  32.     protected $onlyException;
  33.     protected $onlyMasterRequests;
  34.     protected $exception;
  35.     protected $profiles;
  36.     protected $requestStack;
  37.     protected $parents;
  39.     /**
  40.      * @param Profiler                     $profiler           A Profiler instance
  41.      * @param RequestStack                 $requestStack       A RequestStack instance
  42.      * @param RequestMatcherInterface|null $matcher            A RequestMatcher instance
  43.      * @param bool                         $onlyException      True if the profiler only collects data when an exception occurs, false otherwise
  44.      * @param bool                         $onlyMasterRequests True if the profiler only collects data when the request is a master request, false otherwise
  45.      */
  46.     public function __construct(Profiler $profiler, RequestStack $requestStack, RequestMatcherInterface $matcher = null, bool $onlyException = false, bool $onlyMasterRequests = false) {
  47.         $this->profiler = $profiler;
  48.         $this->matcher = $matcher;
  49.         $this->onlyException = $onlyException;
  50.         $this->onlyMasterRequests = $onlyMasterRequests;
  51.         $this->profiles = new \SplObjectStorage();
  52.         $this->parents = new \SplObjectStorage();
  53.         $this->requestStack = $requestStack;
  54.     }
  56.     /**
  57.      * Handles the onKernelException event.
  58.      */
  59.     public function onKernelException(GetResponseForExceptionEvent $event) {
  60.         if ($this->onlyMasterRequests && !$event->isMasterRequest()) {
  61.             return;
  62.         }
  64.         $this->exception = $event->getException();
  65.     }
  67.     /**
  68.      * Handles the onKernelResponse event.
  69.      */
  70.     public function onKernelResponse(FilterResponseEvent $event) {
  71.         $master = $event->isMasterRequest();
  72.         if ($this->onlyMasterRequests && !$master) {
  73.             return;
  74.         }
  76.         if ($this->onlyException && null === $this->exception) {
  77.             return;
  78.         }
  80.         $request = $event->getRequest();
  81.         $exception = $this->exception;
  82.         $this->exception = null;
  84.         if (null !== $this->matcher && !$this->matcher->matches($request)) {
  85.             return;
  86.         }
  88.         if (!$profile = $this->profiler->collect($request, $event->getResponse(), $exception)) {
  89.             return;
  90.         }
  92.         $this->profiles[$request] = $profile;
  94.         $this->parents[$request] = $this->requestStack->getParentRequest();
  95.     }
  97.     public function onKernelTerminate(PostResponseEvent $event) {
  98.         // attach children to parents
  99.         foreach ($this->profiles as $request) {
  100.             if (null !== $parentRequest = $this->parents[$request]) {
  101.                 if (isset($this->profiles[$parentRequest])) {
  102.                     $this->profiles[$parentRequest]->addChild($this->profiles[$request]);
  103.                 }
  104.             }
  105.         }
  107.         // save profiles
  108.         foreach ($this->profiles as $request) {
  109.             $this->profiler->saveProfile($this->profiles[$request]);
  110.         }
  112.         $this->profiles = new \SplObjectStorage();
  113.         $this->parents = new \SplObjectStorage();
  114.     }
  116.     public static function getSubscribedEvents() {
  117.         return [
  118.             KernelEvents::RESPONSE => ['onKernelResponse', -100],
  119.             KernelEvents::EXCEPTION => ['onKernelException', 0],
  120.             KernelEvents::TERMINATE => ['onKernelTerminate', -1024],
  121.         ];
  122.     }
  124. }