Class Symfony\Component\Console\Command\HelpCommand

InheritanceSymfony\Component\Console\Command\HelpCommand » Symfony\Component\Console\Command\Command

HelpCommand displays the help for a given command.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Constructor. Symfony\Component\Console\Command\Command
addArgument() Adds an argument. Symfony\Component\Console\Command\Command
addOption() Adds an option. Symfony\Component\Console\Command\Command
addUsage() Add a command usage example. Symfony\Component\Console\Command\Command
getAliases() Returns the aliases for the command. Symfony\Component\Console\Command\Command
getApplication() Gets the application instance for this command. Symfony\Component\Console\Command\Command
getDefinition() Gets the InputDefinition attached to this Command. Symfony\Component\Console\Command\Command
getDescription() Returns the description for the command. Symfony\Component\Console\Command\Command
getHelp() Returns the help for the command. Symfony\Component\Console\Command\Command
getHelper() Gets a helper instance by name. Symfony\Component\Console\Command\Command
getHelperSet() Gets the helper set. Symfony\Component\Console\Command\Command
getName() Returns the command name. Symfony\Component\Console\Command\Command
getNativeDefinition() Gets the InputDefinition to be used to create representations of this Command. Symfony\Component\Console\Command\Command
getProcessedHelp() Returns the processed help for the command replacing the %command.name% and %command.full_name% patterns with the real values dynamically. Symfony\Component\Console\Command\Command
getSynopsis() Returns the synopsis for the command. Symfony\Component\Console\Command\Command
getUsages() Returns alternative usages of the command. Symfony\Component\Console\Command\Command
ignoreValidationErrors() Ignores validation errors. Symfony\Component\Console\Command\Command
isEnabled() Checks whether the command is enabled or not in the current environment. Symfony\Component\Console\Command\Command
mergeApplicationDefinition() Merges the application definition with the command definition. Symfony\Component\Console\Command\Command
run() Runs the command. Symfony\Component\Console\Command\Command
setAliases() Sets the aliases for the command. Symfony\Component\Console\Command\Command
setApplication() Sets the application instance for this command. Symfony\Component\Console\Command\Command
setCode() Sets the code to execute when running this command. Symfony\Component\Console\Command\Command
setCommand() Sets the command. Symfony\Component\Console\Command\HelpCommand
setDefinition() Sets an array of argument and option instances. Symfony\Component\Console\Command\Command
setDescription() Sets the description for the command. Symfony\Component\Console\Command\Command
setHelp() Sets the help for the command. Symfony\Component\Console\Command\Command
setHelperSet() Sets the helper set. Symfony\Component\Console\Command\Command
setName() Sets the name of the command. Symfony\Component\Console\Command\Command
setProcessTitle() Sets the process title of the command. Symfony\Component\Console\Command\Command

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
configure() {@inheritdoc} Symfony\Component\Console\Command\HelpCommand
execute() {@inheritdoc} Symfony\Component\Console\Command\HelpCommand
initialize() Initializes the command just after the input has been validated. Symfony\Component\Console\Command\Command
interact() Interacts with the user. Symfony\Component\Console\Command\Command

Method Details

configure() protected method

{@inheritdoc}

protected void configure ( )
execute() protected method

{@inheritdoc}

protected void execute ( Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output )
$input
$output
setCommand() public method

Sets the command.

public void setCommand ( Symfony\Component\Console\Command\Command $command )
$command Symfony\Component\Console\Command\Command

The command to set