HelpCommand.php 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Console\Command;
  11. use Symfony\Component\Console\Descriptor\ApplicationDescription;
  12. use Symfony\Component\Console\Helper\DescriptorHelper;
  13. use Symfony\Component\Console\Input\InputArgument;
  14. use Symfony\Component\Console\Input\InputInterface;
  15. use Symfony\Component\Console\Input\InputOption;
  16. use Symfony\Component\Console\Output\OutputInterface;
  17. /**
  18. * HelpCommand displays the help for a given command.
  19. *
  20. * @author Fabien Potencier <fabien@symfony.com>
  21. */
  22. class HelpCommand extends Command
  23. {
  24. private Command $command;
  25. /**
  26. * @return void
  27. */
  28. protected function configure()
  29. {
  30. $this->ignoreValidationErrors();
  31. $this
  32. ->setName('help')
  33. ->setDefinition([
  34. new InputArgument('command_name', InputArgument::OPTIONAL, 'The command name', 'help', fn () => array_keys((new ApplicationDescription($this->getApplication()))->getCommands())),
  35. new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt, xml, json, or md)', 'txt', fn () => (new DescriptorHelper())->getFormats()),
  36. new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw command help'),
  37. ])
  38. ->setDescription('Display help for a command')
  39. ->setHelp(<<<'EOF'
  40. The <info>%command.name%</info> command displays help for a given command:
  41. <info>%command.full_name% list</info>
  42. You can also output the help in other formats by using the <comment>--format</comment> option:
  43. <info>%command.full_name% --format=xml list</info>
  44. To display the list of available commands, please use the <info>list</info> command.
  45. EOF
  46. )
  47. ;
  48. }
  49. /**
  50. * @return void
  51. */
  52. public function setCommand(Command $command)
  53. {
  54. $this->command = $command;
  55. }
  56. protected function execute(InputInterface $input, OutputInterface $output): int
  57. {
  58. $this->command ??= $this->getApplication()->find($input->getArgument('command_name'));
  59. $helper = new DescriptorHelper();
  60. $helper->describe($output, $this->command, [
  61. 'format' => $input->getOption('format'),
  62. 'raw_text' => $input->getOption('raw'),
  63. ]);
  64. unset($this->command);
  65. return 0;
  66. }
  67. }