vendor/symfony/symfony/src/Symfony/Component/HttpKernel/DataCollector/RouterDataCollector.php line 76

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\HttpFoundation\RedirectResponse;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpFoundation\Response;
  17. use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
  19. /**
  20.  * @author Fabien Potencier <fabien@symfony.com>
  21.  */
  22. class RouterDataCollector extends DataCollector
  23. {
  24.     /**
  25.      * @var \SplObjectStorage
  26.      */
  27.     protected $controllers;
  29.     public function __construct()
  30.     {
  31.         $this->reset();
  32.     }
  34.     /**
  35.      * {@inheritdoc}
  36.      *
  37.      * @param \Throwable|null $exception
  38.      *
  39.      * @final since Symfony 4.4
  40.      */
  41.     public function collect(Request $request, Response $response/*, \Throwable $exception = null*/)
  42.     {
  43.         if ($response instanceof RedirectResponse) {
  44.             $this->data['redirect'] = true;
  45.             $this->data['url'] = $response->getTargetUrl();
  47.             if ($this->controllers->contains($request)) {
  48.                 $this->data['route'] = $this->guessRoute($request, $this->controllers[$request]);
  49.             }
  50.         }
  52.         unset($this->controllers[$request]);
  53.     }
  55.     public function reset()
  56.     {
  57.         $this->controllers = new \SplObjectStorage();
  59.         $this->data = [
  60.             'redirect' => false,
  61.             'url' => null,
  62.             'route' => null,
  63.         ];
  64.     }
  66.     protected function guessRoute(Request $request, $controller)
  67.     {
  68.         return 'n/a';
  69.     }
  71.     /**
  72.      * Remembers the controller associated to each request.
  73.      *
  74.      * @final since Symfony 4.3
  75.      */
  76.     public function onKernelController(FilterControllerEvent $event)
  77.     {
  78.         $this->controllers[$event->getRequest()] = $event->getController();
  79.     }
  81.     /**
  82.      * @return bool Whether this request will result in a redirect
  83.      */
  84.     public function getRedirect()
  85.     {
  86.         return $this->data['redirect'];
  87.     }
  89.     /**
  90.      * @return string|null The target URL
  91.      */
  92.     public function getTargetUrl()
  93.     {
  94.         return $this->data['url'];
  95.     }
  97.     /**
  98.      * @return string|null The target route
  99.      */
  100.     public function getTargetRoute()
  101.     {
  102.         return $this->data['route'];
  103.     }
  105.     /**
  106.      * {@inheritdoc}
  107.      */
  108.     public function getName()
  109.     {
  110.         return 'router';
  111.     }
  112. }