1. sfHelpTask.class.php
  2. /**
 * Displays help for a task.
 *
 * @package    symfony
 * @subpackage task
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfHelpTask.class.php 23922 2009-11-14 14:58:38Z fabien $
 */
  3. class sfHelpTask extends sfCommandApplicationTask
  4. {
  5.   /**
  6.    * @see sfTask
  7.    */
  8.   protected function configure()
  9.   {
  10.     $this->addArguments(array(
  11.       new sfCommandArgument('task_name', sfCommandArgument::OPTIONAL, 'The task name', 'help'),
  12.     ));
  14.     $this->addOptions(array(
  15.       new sfCommandOption('xml', null, sfCommandOption::PARAMETER_NONE, 'To output help as XML'),
  16.     ));
  18.     $this->briefDescription = 'Displays help for a task';
  20.     $this->detailedDescription = <<<EOF
  21. The [help|INFO] task displays help for a given task:
  23.   [./symfony help test:all|INFO]
  25. You can also output the help as XML by using the [--xml|COMMENT] option:
  27.   [./symfony help test:all --xml|INFO]
  28. EOF;
  29.   }
  31.   /**
  32.    * @see sfTask
  33.    */
  34.   protected function execute($arguments = array(), $options = array())
  35.   {
  36.     if (!isset($this->commandApplication))
  37.     {
  38.       throw new sfCommandException('You can only launch this task from the command line.');
  39.     }
  41.     $task = $this->commandApplication->getTask($arguments['task_name']);
  43.     if ($options['xml'])
  44.     {
  45.       $this->outputAsXml($task);
  46.     }
  47.     else
  48.     {
  49.       $this->outputAsText($task);
  50.     }
  51.   }
  53.   protected function outputAsText(sfTask $task)
  54.   {
  55.     $messages = array();
  57.     $messages[] = $this->formatter->format('Usage:', 'COMMENT');
  58.     $messages[] = $this->formatter->format(sprintf(' '.$task->getSynopsis(), null === $this->commandApplication ? '' : $this->commandApplication->getName()))."\n";
  60.     // find the largest option or argument name
  61.     $max = 0;
  62.     foreach ($task->getOptions() as $option)
  63.     {
  64.       $max = strlen($option->getName()) + 2 > $max ? strlen($option->getName()) + 2 : $max;
  65.     }
  66.     foreach ($task->getArguments() as $argument)
  67.     {
  68.       $max = strlen($argument->getName()) > $max ? strlen($argument->getName()) : $max;
  69.     }
  70.     $max += strlen($this->formatter->format(' ', 'INFO'));
  72.     if ($task->getAliases())
  73.     {
  74.       $messages[] = $this->formatter->format('Aliases:', 'COMMENT').' '.$this->formatter->format(implode(', ', $task->getAliases()), 'INFO')."\n";
  75.     }
  77.     if ($task->getArguments())
  78.     {
  79.       $messages[] = $this->formatter->format('Arguments:', 'COMMENT');
  80.       foreach ($task->getArguments() as $argument)
  81.       {
  82.         $default = null !== $argument->getDefault() && (!is_array($argument->getDefault()) || count($argument->getDefault())) ? $this->formatter->format(sprintf(' (default: %s)', is_array($argument->getDefault()) ? str_replace("\n", '', print_r($argument->getDefault(), true)): $argument->getDefault()), 'COMMENT') : '';
  83.         $messages[] = sprintf(" %-${max}s %s%s", $this->formatter->format($argument->getName(), 'INFO'), $argument->getHelp(), $default);
  84.       }
  86.       $messages[] = '';
  87.     }
  89.     if ($task->getOptions())
  90.     {
  91.       $messages[] = $this->formatter->format('Options:', 'COMMENT');
  93.       foreach ($task->getOptions() as $option)
  94.       {
  95.         $default = $option->acceptParameter() && null !== $option->getDefault() && (!is_array($option->getDefault()) || count($option->getDefault())) ? $this->formatter->format(sprintf(' (default: %s)', is_array($option->getDefault()) ? str_replace("\n", '', print_r($option->getDefault(), true)): $option->getDefault()), 'COMMENT') : '';
  96.         $multiple = $option->isArray() ? $this->formatter->format(' (multiple values allowed)', 'COMMENT') : '';
  97.         $messages[] = sprintf(' %-'.$max.'s %s%s%s%s', $this->formatter->format('--'.$option->getName(), 'INFO'), $option->getShortcut() ? sprintf('(-%s) ', $option->getShortcut()) : '', $option->getHelp(), $default, $multiple);
  98.       }
  100.       $messages[] = '';
  101.     }
  103.     if ($detailedDescription = $task->getDetailedDescription())
  104.     {
  105.       $messages[] = $this->formatter->format('Description:', 'COMMENT');
  107.       $messages[] = ' '.implode("\n ", explode("\n", $detailedDescription))."\n";
  108.     }
  110.     $this->log($messages);
  111.   }
  113.   protected function outputAsXml(sfTask $task)
  114.   {
  115.     echo $task->asXml();
  116.   }
  117. }
Debug toolbar