<?php /* * This file is part of Psy Shell. * * (c) 2012-2023 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Psy\Command; use Psy\Output\ShellOutput; use Symfony\Component\Console\Helper\TableHelper; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; /** * Help command. * * Lists available commands, and gives command-specific help when asked nicely. */ class HelpCommand extends Command { private $command; /** * {@inheritdoc} */ protected function configure() { $this ->setName('help') ->setAliases(['?']) ->setDefinition([ new InputArgument('command_name', InputArgument::OPTIONAL, 'The command name.', null), ]) ->setDescription('Show a list of commands. Type `help [foo]` for information about [foo].') ->setHelp('My. How meta.'); } /** * Helper for setting a subcommand to retrieve help for. * * @param Command $command */ public function setCommand(Command $command) { $this->command = $command; } /** * {@inheritdoc} * * @return int 0 if everything went fine, or an exit code */ protected function execute(InputInterface $input, OutputInterface $output) { if ($this->command !== null) { // help for an individual command $output->page($this->command->asText()); $this->command = null; } elseif ($name = $input->getArgument('command_name')) { // help for an individual command $output->page($this->getApplication()->get($name)->asText()); } else { // list available commands $commands = $this->getApplication()->all(); $table = $this->getTable($output); foreach ($commands as $name => $command) { if ($name !== $command->getName()) { continue; } if ($command->getAliases()) { $aliases = \sprintf('<comment>Aliases:</comment> %s', \implode(', ', $command->getAliases())); } else { $aliases = ''; } $table->addRow([ \sprintf('<info>%s</info>', $name), $command->getDescription(), $aliases, ]); } if ($output instanceof ShellOutput) { $output->startPaging(); } if ($table instanceof TableHelper) { $table->render($output); } else { $table->render(); } if ($output instanceof ShellOutput) { $output->stopPaging(); } } return 0; } }
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
ListCommand | Folder | 0755 |
|
|
TimeitCommand | Folder | 0755 |
|
|
BufferCommand.php | File | 2.43 KB | 0644 |
|
ClearCommand.php | File | 1.1 KB | 0644 |
|
Command.php | File | 7.67 KB | 0644 |
|
DocCommand.php | File | 9.03 KB | 0644 |
|
DumpCommand.php | File | 2.55 KB | 0644 |
|
EditCommand.php | File | 5.72 KB | 0644 |
|
ExitCommand.php | File | 1.13 KB | 0644 |
|
HelpCommand.php | File | 2.95 KB | 0644 |
|
HistoryCommand.php | File | 7.51 KB | 0644 |
|
ListCommand.php | File | 9.81 KB | 0644 |
|
ParseCommand.php | File | 4.67 KB | 0644 |
|
PsyVersionCommand.php | File | 953 B | 0644 |
|
ReflectingCommand.php | File | 11.6 KB | 0644 |
|
ShowCommand.php | File | 9.64 KB | 0644 |
|
SudoCommand.php | File | 3.76 KB | 0644 |
|
ThrowUpCommand.php | File | 4.36 KB | 0644 |
|
TimeitCommand.php | File | 5.29 KB | 0644 |
|
TraceCommand.php | File | 2.63 KB | 0644 |
|
WhereamiCommand.php | File | 4.26 KB | 0644 |
|
WtfCommand.php | File | 3.76 KB | 0644 |
|