RouterDataCollector.php 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\HttpKernel\DataCollector;
  11. use Symfony\Component\HttpFoundation\RedirectResponse;
  12. use Symfony\Component\HttpFoundation\Request;
  13. use Symfony\Component\HttpFoundation\Response;
  14. use Symfony\Component\HttpKernel\Event\ControllerEvent;
  15. /**
  16. * @author Fabien Potencier <fabien@symfony.com>
  17. */
  18. class RouterDataCollector extends DataCollector
  19. {
  20. /**
  21. * @var \SplObjectStorage<Request, callable>
  22. */
  23. protected $controllers;
  24. public function __construct()
  25. {
  26. $this->reset();
  27. }
  28. /**
  29. * @final
  30. */
  31. public function collect(Request $request, Response $response, ?\Throwable $exception = null): void
  32. {
  33. if ($response instanceof RedirectResponse) {
  34. $this->data['redirect'] = true;
  35. $this->data['url'] = $response->getTargetUrl();
  36. if ($this->controllers->contains($request)) {
  37. $this->data['route'] = $this->guessRoute($request, $this->controllers[$request]);
  38. }
  39. }
  40. unset($this->controllers[$request]);
  41. }
  42. /**
  43. * @return void
  44. */
  45. public function reset()
  46. {
  47. $this->controllers = new \SplObjectStorage();
  48. $this->data = [
  49. 'redirect' => false,
  50. 'url' => null,
  51. 'route' => null,
  52. ];
  53. }
  54. /**
  55. * @return string
  56. */
  57. protected function guessRoute(Request $request, string|object|array $controller)
  58. {
  59. return 'n/a';
  60. }
  61. /**
  62. * Remembers the controller associated to each request.
  63. *
  64. * @return void
  65. */
  66. public function onKernelController(ControllerEvent $event)
  67. {
  68. $this->controllers[$event->getRequest()] = $event->getController();
  69. }
  70. /**
  71. * @return bool Whether this request will result in a redirect
  72. */
  73. public function getRedirect(): bool
  74. {
  75. return $this->data['redirect'];
  76. }
  77. public function getTargetUrl(): ?string
  78. {
  79. return $this->data['url'];
  80. }
  81. public function getTargetRoute(): ?string
  82. {
  83. return $this->data['route'];
  84. }
  85. public function getName(): string
  86. {
  87. return 'router';
  88. }
  89. }