Command.php
3 years ago
CompleteCommand.php
3 years ago
DumpCompletionCommand.php
3 years ago
HelpCommand.php
3 years ago
LazyCommand.php
3 years ago
ListCommand.php
3 years ago
LockableTrait.php
3 years ago
SignalableCommandInterface.php
3 years ago
HelpCommand.php
78 lines
| 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 | namespace IAWP_SCOPED\Symfony\Component\Console\Command; |
| 12 | |
| 13 | use IAWP_SCOPED\Symfony\Component\Console\Completion\CompletionInput; |
| 14 | use IAWP_SCOPED\Symfony\Component\Console\Completion\CompletionSuggestions; |
| 15 | use IAWP_SCOPED\Symfony\Component\Console\Descriptor\ApplicationDescription; |
| 16 | use IAWP_SCOPED\Symfony\Component\Console\Helper\DescriptorHelper; |
| 17 | use IAWP_SCOPED\Symfony\Component\Console\Input\InputArgument; |
| 18 | use IAWP_SCOPED\Symfony\Component\Console\Input\InputInterface; |
| 19 | use IAWP_SCOPED\Symfony\Component\Console\Input\InputOption; |
| 20 | use IAWP_SCOPED\Symfony\Component\Console\Output\OutputInterface; |
| 21 | /** |
| 22 | * HelpCommand displays the help for a given command. |
| 23 | * |
| 24 | * @author Fabien Potencier <fabien@symfony.com> |
| 25 | */ |
| 26 | class HelpCommand extends Command |
| 27 | { |
| 28 | private $command; |
| 29 | /** |
| 30 | * {@inheritdoc} |
| 31 | */ |
| 32 | protected function configure() |
| 33 | { |
| 34 | $this->ignoreValidationErrors(); |
| 35 | $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' |
| 36 | The <info>%command.name%</info> command displays help for a given command: |
| 37 | |
| 38 | <info>%command.full_name% list</info> |
| 39 | |
| 40 | You can also output the help in other formats by using the <comment>--format</comment> option: |
| 41 | |
| 42 | <info>%command.full_name% --format=xml list</info> |
| 43 | |
| 44 | To display the list of available commands, please use the <info>list</info> command. |
| 45 | EOF |
| 46 | ); |
| 47 | } |
| 48 | public function setCommand(Command $command) |
| 49 | { |
| 50 | $this->command = $command; |
| 51 | } |
| 52 | /** |
| 53 | * {@inheritdoc} |
| 54 | */ |
| 55 | protected function execute(InputInterface $input, OutputInterface $output) |
| 56 | { |
| 57 | if (null === $this->command) { |
| 58 | $this->command = $this->getApplication()->find($input->getArgument('command_name')); |
| 59 | } |
| 60 | $helper = new DescriptorHelper(); |
| 61 | $helper->describe($output, $this->command, ['format' => $input->getOption('format'), 'raw_text' => $input->getOption('raw')]); |
| 62 | $this->command = null; |
| 63 | return 0; |
| 64 | } |
| 65 | public function complete(CompletionInput $input, CompletionSuggestions $suggestions) : void |
| 66 | { |
| 67 | if ($input->mustSuggestArgumentValuesFor('command_name')) { |
| 68 | $descriptor = new ApplicationDescription($this->getApplication()); |
| 69 | $suggestions->suggestValues(\array_keys($descriptor->getCommands())); |
| 70 | return; |
| 71 | } |
| 72 | if ($input->mustSuggestOptionValuesFor('format')) { |
| 73 | $helper = new DescriptorHelper(); |
| 74 | $suggestions->suggestValues($helper->getFormats()); |
| 75 | } |
| 76 | } |
| 77 | } |
| 78 |