| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101 | <?php/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */namespace Symfony\Component\Console\Command;use Symfony\Component\Console\Completion\CompletionInput;use Symfony\Component\Console\Completion\CompletionSuggestions;use Symfony\Component\Console\Descriptor\ApplicationDescription;use Symfony\Component\Console\Helper\DescriptorHelper;use Symfony\Component\Console\Input\InputArgument;use Symfony\Component\Console\Input\InputInterface;use Symfony\Component\Console\Input\InputOption;use Symfony\Component\Console\Output\OutputInterface;/** * HelpCommand displays the help for a given command. * * @author Fabien Potencier <fabien@symfony.com> */class HelpCommand extends Command{    private $command;    /**     * {@inheritdoc}     */    protected function configure()    {        $this->ignoreValidationErrors();        $this            ->setName('help')            ->setDefinition([                new InputArgument('command_name', InputArgument::OPTIONAL, 'The command name', 'help'),                new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt, xml, json, or md)', 'txt'),                new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw command help'),            ])            ->setDescription('Display help for a command')            ->setHelp(<<<'EOF'The <info>%command.name%</info> command displays help for a given command:  <info>%command.full_name% list</info>You can also output the help in other formats by using the <comment>--format</comment> option:  <info>%command.full_name% --format=xml list</info>To display the list of available commands, please use the <info>list</info> command.EOF            )        ;    }    public function setCommand(Command $command)    {        $this->command = $command;    }    /**     * {@inheritdoc}     */    protected function execute(InputInterface $input, OutputInterface $output)    {        if (null === $this->command) {            $this->command = $this->getApplication()->find($input->getArgument('command_name'));        }        $helper = new DescriptorHelper();        $helper->describe($output, $this->command, [            'format' => $input->getOption('format'),            'raw_text' => $input->getOption('raw'),        ]);        $this->command = null;        return 0;    }    public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void    {        if ($input->mustSuggestArgumentValuesFor('command_name')) {            $descriptor = new ApplicationDescription($this->getApplication());            $suggestions->suggestValues(array_keys($descriptor->getCommands()));            return;        }        if ($input->mustSuggestOptionValuesFor('format')) {            $helper = new DescriptorHelper();            $suggestions->suggestValues($helper->getFormats());        }    }}
 |