123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128 |
- <?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\Bundle\FrameworkBundle\Command;
- use Symfony\Bundle\FrameworkBundle\Console\Helper\DescriptorHelper;
- use Symfony\Component\Console\Input\InputArgument;
- use Symfony\Component\Console\Input\InputInterface;
- use Symfony\Component\Console\Input\InputOption;
- use Symfony\Component\Console\Output\OutputInterface;
- use Symfony\Component\Console\Style\SymfonyStyle;
- use Symfony\Component\Routing\Route;
- use Symfony\Component\Routing\RouterInterface;
- /**
- * A console command for retrieving information about routes.
- *
- * @author Fabien Potencier <fabien@symfony.com>
- * @author Tobias Schultze <http://tobion.de>
- */
- class RouterDebugCommand extends ContainerAwareCommand
- {
- /**
- * {@inheritdoc}
- */
- public function isEnabled()
- {
- if (!$this->getContainer()->has('router')) {
- return false;
- }
- $router = $this->getContainer()->get('router');
- if (!$router instanceof RouterInterface) {
- return false;
- }
- return parent::isEnabled();
- }
- /**
- * {@inheritdoc}
- */
- protected function configure()
- {
- $this
- ->setName('debug:router')
- ->setAliases(array(
- 'router:debug',
- ))
- ->setDefinition(array(
- new InputArgument('name', InputArgument::OPTIONAL, 'A route name'),
- new InputOption('show-controllers', null, InputOption::VALUE_NONE, 'Show assigned controllers in overview'),
- new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt, xml, json, or md)', 'txt'),
- new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw route(s)'),
- ))
- ->setDescription('Displays current routes for an application')
- ->setHelp(<<<'EOF'
- The <info>%command.name%</info> displays the configured routes:
- <info>php %command.full_name%</info>
- EOF
- )
- ;
- }
- /**
- * {@inheritdoc}
- *
- * @throws \InvalidArgumentException When route does not exist
- */
- protected function execute(InputInterface $input, OutputInterface $output)
- {
- $io = new SymfonyStyle($input, $output);
- if (false !== strpos($input->getFirstArgument(), ':d')) {
- $io->caution('The use of "router:debug" command is deprecated since version 2.7 and will be removed in 3.0. Use the "debug:router" instead.');
- }
- $name = $input->getArgument('name');
- $helper = new DescriptorHelper();
- $routes = $this->getContainer()->get('router')->getRouteCollection();
- if ($name) {
- if (!$route = $routes->get($name)) {
- throw new \InvalidArgumentException(sprintf('The route "%s" does not exist.', $name));
- }
- $this->convertController($route);
- $helper->describe($io, $route, array(
- 'format' => $input->getOption('format'),
- 'raw_text' => $input->getOption('raw'),
- 'name' => $name,
- 'output' => $io,
- ));
- } else {
- foreach ($routes as $route) {
- $this->convertController($route);
- }
- $helper->describe($io, $routes, array(
- 'format' => $input->getOption('format'),
- 'raw_text' => $input->getOption('raw'),
- 'show_controllers' => $input->getOption('show-controllers'),
- 'output' => $io,
- ));
- }
- }
- private function convertController(Route $route)
- {
- $nameParser = $this->getContainer()->get('controller_name_converter');
- if ($route->hasDefault('_controller')) {
- try {
- $route->setDefault('_controller', $nameParser->build($route->getDefault('_controller')));
- } catch (\InvalidArgumentException $e) {
- }
- }
- }
- }
|