class HelpCommand in Zircon Profile 8

HelpCommand displays the help for a given command.

@author Fabien Potencier <[e-mail]>

Hierarchy

• class \Symfony\Component\Console\Command\Command
  • class \Symfony\Component\Console\Command\HelpCommand

2 files declare their use of HelpCommand

Application.php in vendor/symfony/console/Application.php

HelpCommandTest.php in vendor/symfony/console/Tests/Command/HelpCommandTest.php

File

vendor/symfony/console/Command/HelpCommand.php, line 25

Namespace

Symfony\Component\Console\Command

class HelpCommand extends Command {
  private $command;

  /**
   * {@inheritdoc}
   */
  protected function configure() {
    $this
      ->ignoreValidationErrors();
    $this
      ->setName('help')
      ->setDefinition(array(
      new InputArgument('command_name', InputArgument::OPTIONAL, 'The command name', 'help'),
      new InputOption('xml', null, InputOption::VALUE_NONE, 'To output help as XML'),
      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('Displays help for a command')
      ->setHelp(<<<EOF
The <info>%command.name%</info> command displays help for a given command:

  <info>php %command.full_name% list</info>

You can also output the help in other formats by using the <comment>--format</comment> option:

  <info>php %command.full_name% --format=xml list</info>

To display the list of available commands, please use the <info>list</info> command.
EOF
);
  }

  /**
   * Sets the command.
   *
   * @param Command $command The command to set
   */
  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'));
    }
    if ($input
      ->getOption('xml')) {
      @trigger_error('The --xml option was deprecated in version 2.7 and will be removed in version 3.0. Use the --format option instead.', E_USER_DEPRECATED);
      $input
        ->setOption('format', 'xml');
    }
    $helper = new DescriptorHelper();
    $helper
      ->describe($output, $this->command, array(
      'format' => $input
        ->getOption('format'),
      'raw_text' => $input
        ->getOption('raw'),
    ));
    $this->command = null;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Command::$aliases	private	property
Command::$application	private	property
Command::$applicationDefinitionMerged	private	property
Command::$applicationDefinitionMergedWithArgs	private	property
Command::$code	private	property
Command::$definition	private	property
Command::$description	private	property
Command::$help	private	property
Command::$helperSet	private	property
Command::$ignoreValidationErrors	private	property
Command::$name	private	property
Command::$processTitle	private	property
Command::$synopsis	private	property
Command::$usages	private	property
Command::addArgument	public	function	Adds an argument.
Command::addOption	public	function	Adds an option.
Command::addUsage	public	function	Add a command usage example.
Command::asText Deprecated	public	function	Returns a text representation of the command.
Command::asXml Deprecated	public	function	Returns an XML representation of the command.
Command::getAliases	public	function	Returns the aliases for the command.
Command::getApplication	public	function	Gets the application instance for this command.
Command::getDefinition	public	function	Gets the InputDefinition attached to this Command.
Command::getDescription	public	function	Returns the description for the command.
Command::getHelp	public	function	Returns the help for the command.
Command::getHelper	public	function	Gets a helper instance by name.
Command::getHelperSet	public	function	Gets the helper set.
Command::getName	public	function	Returns the command name.
Command::getNativeDefinition	public	function	Gets the InputDefinition to be used to create XML and Text representations of this Command.	1
Command::getProcessedHelp	public	function	Returns the processed help for the command replacing the %command.name% and %command.full_name% patterns with the real values dynamically.
Command::getSynopsis	public	function	Returns the synopsis for the command.
Command::getUsages	public	function	Returns alternative usages of the command.
Command::ignoreValidationErrors	public	function	Ignores validation errors.
Command::initialize	protected	function	Initializes the command just after the input has been validated.
Command::interact	protected	function	Interacts with the user.	2
Command::isEnabled	public	function	Checks whether the command is enabled or not in the current environment.
Command::mergeApplicationDefinition	public	function	Merges the application definition with the command definition.
Command::run	public	function	Runs the command.
Command::setAliases	public	function	Sets the aliases for the command.
Command::setApplication	public	function	Sets the application instance for this command.
Command::setCode	public	function	Sets the code to execute when running this command.
Command::setDefinition	public	function	Sets an array of argument and option instances.
Command::setDescription	public	function	Sets the description for the command.
Command::setHelp	public	function	Sets the help for the command.
Command::setHelperSet	public	function	Sets the helper set.
Command::setName	public	function	Sets the name of the command.
Command::setProcessTitle	public	function	Sets the process title of the command.
Command::validateName	private	function	Validates a command name.
Command::__construct	public	function	Constructor.	3
HelpCommand::$command	private	property
HelpCommand::configure	protected	function	Configures the current command. Overrides Command::configure
HelpCommand::execute	protected	function	Executes the current command. Overrides Command::execute
HelpCommand::setCommand	public	function	Sets the command.