* * This source file is subject to the MIT license that is bundled * with this source code in the file LICENSE. */ /** * RouterDebugCommand. * * @author Fabien Potencier */ class RouterDebugCommand extends Command { /** * @see Command */ protected function configure() { $this ->setDefinition(array( new InputArgument('name', InputArgument::OPTIONAL, 'A route name'), )) ->setName('router:debug') ->setDescription('Displays current routes for an application') ->setHelp(<<router:debug displays the configured routes: router:debug EOF ) ; } /** * @see Command */ protected function execute(InputInterface $input, OutputInterface $output) { $router = $this->container->get('router'); $routes = array(); foreach ($router->getRouteCollection()->getRoutes() as $name => $route) { $routes[$name] = $route->compile(); } if ($input->getArgument('name')) { $this->outputRoute($output, $routes, $input->getArgument('name')); } else { $this->outputRoutes($output, $routes); } } protected function outputRoutes(OutputInterface $output, $routes) { $output->writeln($this->getHelper('formatter')->formatSection('router', 'Current routes')); $maxName = 4; $maxMethod = 6; foreach ($routes as $name => $route) { $requirements = $route->getRequirements(); $method = isset($requirements['_method']) ? strtoupper(is_array($requirements['_method']) ? implode(', ', $requirements['_method']) : $requirements['_method']) : 'ANY'; if (strlen($name) > $maxName) { $maxName = strlen($name); } if (strlen($method) > $maxMethod) { $maxMethod = strlen($method); } } $format = '%-'.$maxName.'s %-'.$maxMethod.'s %s'; // displays the generated routes $format1 = '%-'.($maxName + 9).'s %-'.($maxMethod + 9).'s %s'; $output->writeln(sprintf($format1, 'Name', 'Method', 'Pattern')); foreach ($routes as $name => $route) { $requirements = $route->getRequirements(); $method = isset($requirements['_method']) ? strtoupper(is_array($requirements['_method']) ? implode(', ', $requirements['_method']) : $requirements['_method']) : 'ANY'; $output->writeln(sprintf($format, $name, $method, $route->getPattern())); } } /** * @throws \InvalidArgumentException When route does not exist */ protected function outputRoute(OutputInterface $output, $routes, $name) { $output->writeln($this->getHelper('formatter')->formatSection('router', sprintf('Route "%s"', $name))); if (!isset($routes[$name])) { throw new \InvalidArgumentException(sprintf('The route "%s" does not exist.', $name)); } $route = $routes[$name]; $output->writeln(sprintf('Name %s', $name)); $output->writeln(sprintf('Pattern %s', $route->getPattern())); $output->writeln(sprintf('Class %s', get_class($route))); $defaults = ''; $d = $route->getDefaults(); ksort($d); foreach ($d as $name => $value) { $defaults .= ($defaults ? "\n".str_repeat(' ', 13) : '').$name.': '.$this->formatValue($value); } $output->writeln(sprintf('Defaults %s', $defaults)); $requirements = ''; $r = $route->getRequirements(); ksort($r); foreach ($r as $name => $value) { $requirements .= ($requirements ? "\n".str_repeat(' ', 13) : '').$name.': '.$this->formatValue($value); } $output->writeln(sprintf('Requirements %s', $requirements)); $options = ''; $o = $route->getOptions(); ksort($o); foreach ($o as $name => $value) { $options .= ($options ? "\n".str_repeat(' ', 13) : '').$name.': '.$this->formatValue($value); } $output->writeln(sprintf('Options %s', $options)); $output->write('Regex '); $output->writeln(preg_replace('/^ /', '', preg_replace('/^/m', ' ', $route->getRegex())), Output::OUTPUT_RAW); $tokens = ''; foreach ($route->getTokens() as $token) { if (!$tokens) { $tokens = $this->displayToken($token); } else { $tokens .= "\n".str_repeat(' ', 13).$this->displayToken($token); } } $output->writeln(sprintf('Tokens %s', $tokens)); } protected function displayToken($token) { $type = array_shift($token); array_shift($token); return sprintf('%-10s %s', $type, $this->formatValue($token)); } protected function formatValue($value) { if (is_object($value)) { return sprintf('object(%s)', get_class($value)); } else { return preg_replace("/\n\s*/s", '', var_export($value, true)); } } }