1. sfAppRoutesTask.class.php
  2. /**
 * Displays the current routes for an application.
 *
 * @package    symfony
 * @subpackage task
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfAppRoutesTask.class.php 23549 2009-11-03 09:10:12Z fabien $
 */
  3. class sfAppRoutesTask extends sfBaseTask
  4. {
  5.   protected
  6.     $routes = array();
  8.   /**
  9.    * @see sfTask
  10.    */
  11.   protected function configure()
  12.   {
  13.     $this->addArguments(array(
  14.       new sfCommandArgument('application', sfCommandArgument::REQUIRED, 'The application name'),
  15.       new sfCommandArgument('name', sfCommandArgument::OPTIONAL, 'A route name'),
  16.     ));
  18.     $this->namespace = 'app';
  19.     $this->name = 'routes';
  20.     $this->briefDescription = 'Displays current routes for an application';
  22.     $this->detailedDescription = <<<EOF
  23. The [app:routes|INFO] displays the current routes for a given application:
  25.   [./symfony app:routes frontend|INFO]
  26. EOF;
  27.   }
  29.   /**
  30.    * @see sfTask
  31.    */
  32.   protected function execute($arguments = array(), $options = array())
  33.   {
  34.     $this->routes = $this->getRouting()->getRoutes();
  36.     // display
  37.     $arguments['name'] ? $this->outputRoute($arguments['application'], $arguments['name']) : $this->outputRoutes($arguments['application']);
  38.   }
  40.   protected function outputRoutes($application)
  41.   {
  42.     $this->logSection('app', sprintf('Current routes for application "%s"', $application));
  44.     $maxName = 4;
  45.     $maxMethod = 6;
  46.     foreach ($this->routes as $name => $route)
  47.     {
  48.       $requirements = $route->getRequirements();
  49.       $method = isset($requirements['sf_method']) ? strtoupper(is_array($requirements['sf_method']) ? implode(', ', $requirements['sf_method']) : $requirements['sf_method']) : 'ANY';
  51.       if (strlen($name) > $maxName)
  52.       {
  53.         $maxName = strlen($name);
  54.       }
  56.       if (strlen($method) > $maxMethod)
  57.       {
  58.         $maxMethod = strlen($method);
  59.       }
  60.     }
  61.     $format  = '%-'.$maxName.'s %-'.$maxMethod.'s %s';
  63.     // displays the generated routes
  64.     $format1  = '%-'.($maxName + 9).'s %-'.($maxMethod + 9).'s %s';
  65.     $this->log(sprintf($format1, $this->formatter->format('Name', 'COMMENT'), $this->formatter->format('Method', 'COMMENT'), $this->formatter->format('Pattern', 'COMMENT')));
  66.     foreach ($this->routes as $name => $route)
  67.     {
  68.       $requirements = $route->getRequirements();
  69.       $method = isset($requirements['sf_method']) ? strtoupper(is_array($requirements['sf_method']) ? implode(', ', $requirements['sf_method']) : $requirements['sf_method']) : 'ANY';
  70.       $this->log(sprintf($format, $name, $method, $route->getPattern()));
  71.     }
  72.   }
  74.   protected function outputRoute($application, $name)
  75.   {
  76.     $this->logSection('app', sprintf('Route "%s" for application "%s"', $name, $application));
  78.     if (!isset($this->routes[$name]))
  79.     {
  80.       throw new sfCommandException(sprintf('The route "%s" does not exist.', $name));
  81.     }
  83.     $route = $this->routes[$name];
  84.     $this->log(sprintf('%s         %s', $this->formatter->format('Name', 'COMMENT'), $name));
  85.     $this->log(sprintf('%s      %s', $this->formatter->format('Pattern', 'COMMENT'), $route->getPattern()));
  86.     $this->log(sprintf('%s        %s', $this->formatter->format('Class', 'COMMENT'), get_class($route)));
  88.     $defaults = '';
  89.     $d = $route->getDefaults();
  90.     ksort($d);
  91.     foreach ($d as $name => $value)
  92.     {
  93.       $defaults .= ($defaults ? "\n".str_repeat(' ', 13) : '').$name.': '.$this->formatValue($value);
  94.     }
  95.     $this->log(sprintf('%s     %s', $this->formatter->format('Defaults', 'COMMENT'), $defaults));
  97.     $requirements = '';
  98.     $r = $route->getRequirements();
  99.     ksort($r);
  100.     foreach ($r as $name => $value)
  101.     {
  102.       $requirements .= ($requirements ? "\n".str_repeat(' ', 13) : '').$name.': '.$this->formatValue($value);
  103.     }
  104.     $this->log(sprintf('%s %s', $this->formatter->format('Requirements', 'COMMENT'), $requirements));
  106.     $options = '';
  107.     $o = $route->getOptions();
  108.     ksort($o);
  109.     foreach ($o as $name => $value)
  110.     {
  111.       $options .= ($options ? "\n".str_repeat(' ', 13) : '').$name.': '.$this->formatValue($value);
  112.     }
  113.     $this->log(sprintf('%s      %s', $this->formatter->format('Options', 'COMMENT'), $options));
  114.     $this->log(sprintf('%s        %s', $this->formatter->format('Regex', 'COMMENT'), preg_replace('/^             /', '', preg_replace('/^/m', '             ', $route->getRegex()))));
  116.     $tokens = '';
  117.     foreach ($route->getTokens() as $token)
  118.     {
  119.       if (!$tokens)
  120.       {
  121.         $tokens = $this->displayToken($token);
  122.       }
  123.       else
  124.       {
  125.         $tokens .= "\n".str_repeat(' ', 13).$this->displayToken($token);
  126.       }
  127.     }
  128.     $this->log(sprintf('%s       %s', $this->formatter->format('Tokens', 'COMMENT'), $tokens));
  129.   }
  131.   protected function displayToken($token)
  132.   {
  133.     $type = array_shift($token);
  134.     array_shift($token);
  136.     return sprintf('%-10s %s', $type, $this->formatValue($token));
  137.   }
  139.   protected function formatValue($value)
  140.   {
  141.     if (is_object($value))
  142.     {
  143.       return sprintf('object(%s)', get_class($value));
  144.     }
  145.     else
  146.     {
  147.       return preg_replace("/\n\s*/s", '', var_export($value, true));
  148.     }
  149.   }
  150. }
Debug toolbar