vendor/symfony/framework-bundle/Command/RouterDebugCommand.php line 45

  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\Bundle\FrameworkBundle\Command;
  14. use Symfony\Bundle\FrameworkBundle\Console\Helper\DescriptorHelper;
  15. use Symfony\Component\Console\Attribute\AsCommand;
  16. use Symfony\Component\Console\Command\Command;
  17. use Symfony\Component\Console\Completion\CompletionInput;
  18. use Symfony\Component\Console\Completion\CompletionSuggestions;
  19. use Symfony\Component\Console\Exception\InvalidArgumentException;
  20. use Symfony\Component\Console\Input\InputArgument;
  21. use Symfony\Component\Console\Input\InputInterface;
  22. use Symfony\Component\Console\Input\InputOption;
  23. use Symfony\Component\Console\Output\OutputInterface;
  24. use Symfony\Component\Console\Style\SymfonyStyle;
  25. use Symfony\Component\HttpKernel\Debug\FileLinkFormatter;
  26. use Symfony\Component\Routing\RouteCollection;
  27. use Symfony\Component\Routing\RouterInterface;
  29. /**
  30.  * A console command for retrieving information about routes.
  31.  *
  32.  * @author Fabien Potencier <fabien@symfony.com>
  33.  * @author Tobias Schultze <http://tobion.de>
  34.  *
  35.  * @final
  36.  */
  37. #[AsCommand(name: 'debug:router', description: 'Display current routes for an application')]
  38. class RouterDebugCommand extends Command
  39. {
  40.     use BuildDebugContainerTrait;
  42.     private RouterInterface $router;
  43.     private ?FileLinkFormatter $fileLinkFormatter;
  45.     public function __construct(RouterInterface $router, FileLinkFormatter $fileLinkFormatter = null)
  46.     {
  47.         parent::__construct();
  49.         $this->router = $router;
  50.         $this->fileLinkFormatter = $fileLinkFormatter;
  51.     }
  53.     protected function configure()
  54.     {
  55.         $this
  56.             ->setDefinition([
  57.                 new InputArgument('name', InputArgument::OPTIONAL, 'A route name'),
  58.                 new InputOption('show-controllers', null, InputOption::VALUE_NONE, 'Show assigned controllers in overview'),
  59.                 new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt, xml, json, or md)', 'txt'),
  60.                 new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw route(s)'),
  61.             ])
  62.             ->setHelp(<<<'EOF'
  63. The <info>%command.name%</info> displays the configured routes:
  65.   <info>php %command.full_name%</info>
  67. EOF
  68.             )
  69.         ;
  70.     }
  72.     /**
  73.      * @throws InvalidArgumentException When route does not exist
  74.      */
  75.     protected function execute(InputInterface $input, OutputInterface $output): int
  76.     {
  77.         $io = new SymfonyStyle($input, $output);
  78.         $name = $input->getArgument('name');
  79.         $helper = new DescriptorHelper($this->fileLinkFormatter);
  80.         $routes = $this->router->getRouteCollection();
  81.         $container = null;
  82.         if ($this->fileLinkFormatter) {
  83.             $container = function () {
  84.                 return $this->getContainerBuilder($this->getApplication()->getKernel());
  85.             };
  86.         }
  88.         if ($name) {
  89.             $route = $routes->get($name);
  90.             $matchingRoutes = $this->findRouteNameContaining($name, $routes);
  92.             if (!$input->isInteractive() && !$route && \count($matchingRoutes) > 1) {
  93.                 $helper->describe($io, $this->findRouteContaining($name, $routes), [
  94.                     'format' => $input->getOption('format'),
  95.                     'raw_text' => $input->getOption('raw'),
  96.                     'show_controllers' => $input->getOption('show-controllers'),
  97.                     'output' => $io,
  98.                 ]);
  100.                 return 0;
  101.             }
  103.             if (!$route && $matchingRoutes) {
  104.                 $default = 1 === \count($matchingRoutes) ? $matchingRoutes[0] : null;
  105.                 $name = $io->choice('Select one of the matching routes', $matchingRoutes, $default);
  106.                 $route = $routes->get($name);
  107.             }
  109.             if (!$route) {
  110.                 throw new InvalidArgumentException(sprintf('The route "%s" does not exist.', $name));
  111.             }
  113.             $helper->describe($io, $route, [
  114.                 'format' => $input->getOption('format'),
  115.                 'raw_text' => $input->getOption('raw'),
  116.                 'name' => $name,
  117.                 'output' => $io,
  118.                 'container' => $container,
  119.             ]);
  120.         } else {
  121.             $helper->describe($io, $routes, [
  122.                 'format' => $input->getOption('format'),
  123.                 'raw_text' => $input->getOption('raw'),
  124.                 'show_controllers' => $input->getOption('show-controllers'),
  125.                 'output' => $io,
  126.                 'container' => $container,
  127.             ]);
  128.         }
  130.         return 0;
  131.     }
  133.     private function findRouteNameContaining(string $name, RouteCollection $routes): array
  134.     {
  135.         $foundRoutesNames = [];
  136.         foreach ($routes as $routeName => $route) {
  137.             if (false !== stripos($routeName, $name)) {
  138.                 $foundRoutesNames[] = $routeName;
  139.             }
  140.         }
  142.         return $foundRoutesNames;
  143.     }
  145.     public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
  146.     {
  147.         if ($input->mustSuggestArgumentValuesFor('name')) {
  148.             $suggestions->suggestValues(array_keys($this->router->getRouteCollection()->all()));
  150.             return;
  151.         }
  153.         if ($input->mustSuggestOptionValuesFor('format')) {
  154.             $helper = new DescriptorHelper();
  155.             $suggestions->suggestValues($helper->getFormats());
  156.         }
  157.     }
  159.     private function findRouteContaining(string $name, RouteCollection $routes): RouteCollection
  160.     {
  161.         $foundRoutes = new RouteCollection();
  162.         foreach ($routes as $routeName => $route) {
  163.             if (false !== stripos($routeName, $name)) {
  164.                 $foundRoutes->add($routeName, $route);
  165.             }
  166.         }
  168.         return $foundRoutes;
  169.     }
  170. }