/vendor/symfony/http-kernel/EventListener/ProfilerListener.php
PHP | 165 lines | 100 code | 21 blank | 44 comment | 15 complexity | 079b12b7f0631e470a9cb59972bbe3d6 MD5 | raw file
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\HttpKernel\EventListener;
- use Symfony\Component\HttpKernel\Event\GetResponseEvent;
- use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
- use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
- use Symfony\Component\HttpKernel\Event\PostResponseEvent;
- use Symfony\Component\HttpKernel\KernelEvents;
- use Symfony\Component\HttpKernel\Profiler\Profiler;
- use Symfony\Component\HttpFoundation\RequestMatcherInterface;
- use Symfony\Component\HttpFoundation\RequestStack;
- use Symfony\Component\EventDispatcher\EventSubscriberInterface;
- /**
- * ProfilerListener collects data for the current request by listening to the kernel events.
- *
- * @author Fabien Potencier <fabien@symfony.com>
- */
- class ProfilerListener implements EventSubscriberInterface
- {
- protected $profiler;
- protected $matcher;
- protected $onlyException;
- protected $onlyMasterRequests;
- protected $exception;
- protected $requests = array();
- protected $profiles;
- protected $requestStack;
- protected $parents;
- /**
- * Constructor.
- *
- * @param Profiler $profiler A Profiler instance
- * @param RequestMatcherInterface|null $matcher A RequestMatcher instance
- * @param bool $onlyException true if the profiler only collects data when an exception occurs, false otherwise
- * @param bool $onlyMasterRequests true if the profiler only collects data when the request is a master request, false otherwise
- * @param RequestStack|null $requestStack A RequestStack instance
- */
- public function __construct(Profiler $profiler, RequestMatcherInterface $matcher = null, $onlyException = false, $onlyMasterRequests = false, RequestStack $requestStack = null)
- {
- if (null === $requestStack) {
- // Prevent the deprecation notice to be triggered all the time.
- // The onKernelRequest() method fires some logic only when the
- // RequestStack instance is not provided as a dependency.
- @trigger_error('Since version 2.4, the '.__METHOD__.' method must accept a RequestStack instance to get the request instead of using the '.__CLASS__.'::onKernelRequest method that will be removed in 3.0.', E_USER_DEPRECATED);
- }
- $this->profiler = $profiler;
- $this->matcher = $matcher;
- $this->onlyException = (bool) $onlyException;
- $this->onlyMasterRequests = (bool) $onlyMasterRequests;
- $this->profiles = new \SplObjectStorage();
- $this->parents = new \SplObjectStorage();
- $this->requestStack = $requestStack;
- }
- /**
- * Handles the onKernelException event.
- *
- * @param GetResponseForExceptionEvent $event A GetResponseForExceptionEvent instance
- */
- public function onKernelException(GetResponseForExceptionEvent $event)
- {
- if ($this->onlyMasterRequests && !$event->isMasterRequest()) {
- return;
- }
- $this->exception = $event->getException();
- }
- /**
- * @deprecated since version 2.4, to be removed in 3.0.
- */
- public function onKernelRequest(GetResponseEvent $event)
- {
- if (null === $this->requestStack) {
- $this->requests[] = $event->getRequest();
- }
- }
- /**
- * Handles the onKernelResponse event.
- *
- * @param FilterResponseEvent $event A FilterResponseEvent instance
- */
- public function onKernelResponse(FilterResponseEvent $event)
- {
- $master = $event->isMasterRequest();
- if ($this->onlyMasterRequests && !$master) {
- return;
- }
- if ($this->onlyException && null === $this->exception) {
- return;
- }
- $request = $event->getRequest();
- $exception = $this->exception;
- $this->exception = null;
- if (null !== $this->matcher && !$this->matcher->matches($request)) {
- return;
- }
- if (!$profile = $this->profiler->collect($request, $event->getResponse(), $exception)) {
- return;
- }
- $this->profiles[$request] = $profile;
- if (null !== $this->requestStack) {
- $this->parents[$request] = $this->requestStack->getParentRequest();
- } elseif (!$master) {
- // to be removed when requestStack is required
- array_pop($this->requests);
- $this->parents[$request] = end($this->requests);
- }
- }
- public function onKernelTerminate(PostResponseEvent $event)
- {
- // attach children to parents
- foreach ($this->profiles as $request) {
- // isset call should be removed when requestStack is required
- if (isset($this->parents[$request]) && null !== $parentRequest = $this->parents[$request]) {
- if (isset($this->profiles[$parentRequest])) {
- $this->profiles[$parentRequest]->addChild($this->profiles[$request]);
- }
- }
- }
- // save profiles
- foreach ($this->profiles as $request) {
- $this->profiler->saveProfile($this->profiles[$request]);
- }
- $this->profiles = new \SplObjectStorage();
- $this->parents = new \SplObjectStorage();
- $this->requests = array();
- }
- public static function getSubscribedEvents()
- {
- return array(
- // kernel.request must be registered as early as possible to not break
- // when an exception is thrown in any other kernel.request listener
- KernelEvents::REQUEST => array('onKernelRequest', 1024),
- KernelEvents::RESPONSE => array('onKernelResponse', -100),
- KernelEvents::EXCEPTION => 'onKernelException',
- KernelEvents::TERMINATE => array('onKernelTerminate', -1024),
- );
- }
- }