vendor/symfony/http-kernel/DataCollector/RouterDataCollector.php line 72

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\ControllerEvent;
  19. /**
  20. * @author Fabien Potencier <fabien@symfony.com>
  21. */
  22. class RouterDataCollector extends DataCollector
  23. {
  24. /**
  25. * @var \SplObjectStorage<Request, callable>
  26. */
  27. protected $controllers;
  29. public function __construct()
  30. {
  31. $this->reset();
  32. }
  34. /**
  35. * {@inheritdoc}
  36. *
  37. * @final
  38. */
  39. public function collect(Request $request, Response $response, \Throwable $exception = null)
  40. {
  41. if ($response instanceof RedirectResponse) {
  42. $this->data['redirect'] = true;
  43. $this->data['url'] = $response->getTargetUrl();
  45. if ($this->controllers->contains($request)) {
  46. $this->data['route'] = $this->guessRoute($request, $this->controllers[$request]);
  47. }
  48. }
  50. unset($this->controllers[$request]);
  51. }
  53. public function reset()
  54. {
  55. $this->controllers = new \SplObjectStorage();
  57. $this->data = [
  58. 'redirect' => false,
  59. 'url' => null,
  60. 'route' => null,
  61. ];
  62. }
  64. protected function guessRoute(Request $request, string|object|array $controller)
  65. {
  66. return 'n/a';
  67. }
  69. /**
  70. * Remembers the controller associated to each request.
  71. */
  72. public function onKernelController(ControllerEvent $event)
  73. {
  74. $this->controllers[$event->getRequest()] = $event->getController();
  75. }
  77. /**
  78. * @return bool Whether this request will result in a redirect
  79. */
  80. public function getRedirect(): bool
  81. {
  82. return $this->data['redirect'];
  83. }
  85. public function getTargetUrl(): ?string
  86. {
  87. return $this->data['url'];
  88. }
  90. public function getTargetRoute(): ?string
  91. {
  92. return $this->data['route'];
  93. }
  95. /**
  96. * {@inheritdoc}
  97. */
  98. public function getName(): string
  99. {
  100. return 'router';
  101. }
  102. }