* * This source file is subject to the MIT license that is bundled * with this source code in the file LICENSE. */ /** * HelpCommand displays the help for a given command. * * @package symfony * @subpackage console * @author Fabien Potencier */ class HelpCommand extends Command { protected $command; /** * @see Command */ protected function configure() { $this->ignoreValidationErrors = true; $this ->setDefinition(array( new InputArgument('command_name', InputArgument::OPTIONAL, 'The command name', 'help'), new InputOption('xml', null, InputOption::PARAMETER_NONE, 'To output help as XML'), )) ->setName('help') ->setAliases(array('?')) ->setDescription('Displays help for a command') ->setHelp(<<help command displays help for a given command: ./symfony help test:all You can also output the help as XML by using the --xml option: ./symfony help --xml test:all EOF ); } public function setCommand(Command $command) { $this->command = $command; } /** * @see Command */ protected function execute(InputInterface $input, OutputInterface $output) { if (null === $this->command) { $this->command = $this->application->getCommand($input->getArgument('command_name')); } if ($input->getOption('xml')) { $output->writeln($this->command->asXml(), Output::OUTPUT_RAW); } else { $output->writeln($this->command->asText()); } } }