[Summary view] [Print] [Text view]

   1  <?php
   2  
   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   */
  11  
  12  namespace Symfony\Component\Console\Command;
  13  
  14  use Symfony\Component\Console\Helper\DescriptorHelper;
  15  use Symfony\Component\Console\Input\InputArgument;
  16  use Symfony\Component\Console\Input\InputInterface;
  17  use Symfony\Component\Console\Input\InputOption;
  18  use Symfony\Component\Console\Output\OutputInterface;
  19  
  20  /**
  21   * HelpCommand displays the help for a given command.
  22   *
  23   * @author Fabien Potencier <fabien@symfony.com>
  24   */
  25  class HelpCommand extends Command
  26  {
  27      private $command;
  28  
  29      /**
  30       * {@inheritdoc}
  31       */
  32      protected function configure()
  33      {
  34          $this->ignoreValidationErrors();
  35  
  36          $this
  37              ->setName('help')
  38              ->setDefinition(array(
  39                  new InputArgument('command_name', InputArgument::OPTIONAL, 'The command name', 'help'),
  40                  new InputOption('xml', null, InputOption::VALUE_NONE, 'To output help as XML'),
  41                  new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt, xml, json, or md)', 'txt'),
  42                  new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw command help'),
  43              ))
  44              ->setDescription('Displays help for a command')
  45              ->setHelp(<<<'EOF'
  46  The <info>%command.name%</info> command displays help for a given command:
  47  
  48    <info>php %command.full_name% list</info>
  49  
  50  You can also output the help in other formats by using the <comment>--format</comment> option:
  51  
  52    <info>php %command.full_name% --format=xml list</info>
  53  
  54  To display the list of available commands, please use the <info>list</info> command.
  55  EOF
  56              )
  57          ;
  58      }
  59  
  60      public function setCommand(Command $command)
  61      {
  62          $this->command = $command;
  63      }
  64  
  65      /**
  66       * {@inheritdoc}
  67       */
  68      protected function execute(InputInterface $input, OutputInterface $output)
  69      {
  70          if (null === $this->command) {
  71              $this->command = $this->getApplication()->find($input->getArgument('command_name'));
  72          }
  73  
  74          if ($input->getOption('xml')) {
  75              @trigger_error('The --xml option was deprecated in version 2.7 and will be removed in version 3.0. Use the --format option instead.', E_USER_DEPRECATED);
  76  
  77              $input->setOption('format', 'xml');
  78          }
  79  
  80          $helper = new DescriptorHelper();
  81          $helper->describe($output, $this->command, array(
  82              'format' => $input->getOption('format'),
  83              'raw_text' => $input->getOption('raw'),
  84          ));
  85  
  86          $this->command = null;
  87      }
  88  }