You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
75 lines
2.5 KiB
75 lines
2.5 KiB
<?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\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; |
|
|
|
/** |
|
* ListCommand displays the list of all available commands for the application. |
|
* |
|
* @author Fabien Potencier <fabien@symfony.com> |
|
*/ |
|
class ListCommand extends Command |
|
{ |
|
/** |
|
* @return void |
|
*/ |
|
protected function configure() |
|
{ |
|
$this |
|
->setName('list') |
|
->setDefinition([ |
|
new InputArgument('namespace', InputArgument::OPTIONAL, 'The namespace name', null, fn () => array_keys((new ApplicationDescription($this->getApplication()))->getNamespaces())), |
|
new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw command list'), |
|
new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt, xml, json, or md)', 'txt', fn () => (new DescriptorHelper())->getFormats()), |
|
new InputOption('short', null, InputOption::VALUE_NONE, 'To skip describing commands\' arguments'), |
|
]) |
|
->setDescription('List commands') |
|
->setHelp(<<<'EOF' |
|
The <info>%command.name%</info> command lists all commands: |
|
|
|
<info>%command.full_name%</info> |
|
|
|
You can also display the commands for a specific namespace: |
|
|
|
<info>%command.full_name% test</info> |
|
|
|
You can also output the information in other formats by using the <comment>--format</comment> option: |
|
|
|
<info>%command.full_name% --format=xml</info> |
|
|
|
It's also possible to get raw list of commands (useful for embedding command runner): |
|
|
|
<info>%command.full_name% --raw</info> |
|
EOF |
|
) |
|
; |
|
} |
|
|
|
protected function execute(InputInterface $input, OutputInterface $output): int |
|
{ |
|
$helper = new DescriptorHelper(); |
|
$helper->describe($output, $this->getApplication(), [ |
|
'format' => $input->getOption('format'), |
|
'raw_text' => $input->getOption('raw'), |
|
'namespace' => $input->getArgument('namespace'), |
|
'short' => $input->getOption('short'), |
|
]); |
|
|
|
return 0; |
|
} |
|
}
|
|
|