Symfony2 API
Class

Symfony\Component\Console\Command\HelpCommand

class HelpCommand extends Command

HelpCommand displays the help for a given command.

Methods

__construct(string $name = null)

Constructor.

 from Command
ignoreValidationErrors()

Ignores validation errors.

 from Command
setApplication(Application $application = null)

Sets the application instance for this command.

 from Command
setHelperSet(HelperSet $helperSet)

Sets the helper set.

 from Command
HelperSet getHelperSet()

Gets the helper set.

 from Command
Application getApplication()

Gets the application instance for this command.

 from Command
Boolean isEnabled()

Checks whether the command is enabled or not in the current environment

 from Command
integer run(InputInterface $input, OutputInterface $output)

Runs the command.

 from Command
Command setCode(callable $code)

Sets the code to execute when running this command.

 from Command
mergeApplicationDefinition(Boolean $mergeArgs = true)

Merges the application definition with the command definition.

 from Command
Command setDefinition(array|InputDefinition $definition)

Sets an array of argument and option instances.

 from Command
InputDefinition getDefinition()

Gets the InputDefinition attached to this Command.

 from Command
InputDefinition getNativeDefinition()

Gets the InputDefinition to be used to create XML and Text representations of this Command.

 from Command
Command addArgument(string $name, integer $mode = null, string $description = '', mixed $default = null)

Adds an argument.

 from Command
Command addOption(string $name, string $shortcut = null, integer $mode = null, string $description = '', mixed $default = null)

Adds an option.

 from Command
Command setName(string $name)

Sets the name of the command.

 from Command
string getName()

Returns the command name.

 from Command
Command setDescription(string $description)

Sets the description for the command.

 from Command
string getDescription()

Returns the description for the command.

 from Command
Command setHelp(string $help)

Sets the help for the command.

 from Command
string getHelp()

Returns the help for the command.

 from Command
string getProcessedHelp()

Returns the processed help for the command replacing the %command.name% and %command.full_name% patterns with the real values dynamically.

 from Command
Command setAliases(array $aliases)

Sets the aliases for the command.

 from Command
array getAliases()

Returns the aliases for the command.

 from Command
string getSynopsis()

Returns the synopsis for the command.

 from Command
mixed getHelper(string $name)

Gets a helper instance by name.

 from Command
string asText()

Returns a text representation of the command.

 from Command
string|DOMDocument asXml(Boolean $asDom = false)

Returns an XML representation of the command.

 from Command
setCommand(Command $command)

Sets the command

Details

in Command at line 55
public __construct(string $name = null)

Constructor.

Parameters

string $name The name of the command

Exceptions

LogicException When the command name is empty

in Command at line 79
public ignoreValidationErrors()

Ignores validation errors.

This is mainly useful for the help command.

in Command at line 91
public setApplication(Application $application = null)

Sets the application instance for this command.

Parameters

Application $application An Application instance

in Command at line 106
public setHelperSet(HelperSet $helperSet)

Sets the helper set.

Parameters

HelperSet $helperSet A HelperSet instance

in Command at line 116
public HelperSet getHelperSet()

Gets the helper set.

Return Value

HelperSet A HelperSet instance

in Command at line 128
public Application getApplication()

Gets the application instance for this command.

Return Value

Application An Application instance

in Command at line 141
public Boolean isEnabled()

Checks whether the command is enabled or not in the current environment

Override this to check for x or y and return false if the command can not
run properly under the current conditions.

Return Value

Boolean

in Command at line 216
public integer run(InputInterface $input, OutputInterface $output)

Runs the command.

The code to execute is either defined directly with the
setCode() method or by overriding the execute() method
in a sub-class.

Parameters

InputInterface $input An InputInterface instance
OutputInterface $output An OutputInterface instance

Return Value

integer The command exit code

Exceptions

Exception

See also

setCode()
execute()

in Command at line 266
public Command setCode(callable $code)

Sets the code to execute when running this command.

If this method is used, it overrides the code defined
in the execute() method.

Parameters

callable $code A callable(InputInterface $input, OutputInterface $output)

Return Value

Command The current instance

Exceptions

InvalidArgumentException

See also

execute()

in Command at line 284
public mergeApplicationDefinition(Boolean $mergeArgs = true)

Merges the application definition with the command definition.

This method is not part of public API and should not be used directly.

Parameters

Boolean $mergeArgs Whether to merge or not the Application definition arguments to Command definition arguments

in Command at line 313
public Command setDefinition(array|InputDefinition $definition)

Sets an array of argument and option instances.

Parameters

array|InputDefinition $definition An array of argument and option instances or a definition instance

Return Value

Command The current instance

in Command at line 333
public InputDefinition getDefinition()

Gets the InputDefinition attached to this Command.

Return Value

InputDefinition An InputDefinition instance

in Command at line 348
public InputDefinition getNativeDefinition()

Gets the InputDefinition to be used to create XML and Text representations of this Command.

Can be overridden to provide the original command representation when it would otherwise
be changed by merging with the application InputDefinition.

This method is not part of public API and should not be used directly.

Return Value

InputDefinition An InputDefinition instance

in Command at line 365
public Command addArgument(string $name, integer $mode = null, string $description = '', mixed $default = null)

Adds an argument.

Parameters

string $name The argument name
integer $mode The argument mode: InputArgument::REQUIRED or InputArgument::OPTIONAL
string $description A description text
mixed $default The default value (for InputArgument::OPTIONAL mode only)

Return Value

Command The current instance

in Command at line 385
public Command addOption(string $name, string $shortcut = null, integer $mode = null, string $description = '', mixed $default = null)

Adds an option.

Parameters

string $name The option name
string $shortcut The shortcut (can be null)
integer $mode The option mode: One of the InputOption::VALUE_* constants
string $description A description text
mixed $default The default value (must be null for InputOption::VALUE_REQUIRED or InputOption::VALUE_NONE)

Return Value

Command The current instance

in Command at line 408
public Command setName(string $name)

Sets the name of the command.

This method can set both the namespace and the name if
you separate them by a colon (:)

$command->setName('foo:bar');

Parameters

string $name The command name

Return Value

Command The current instance

Exceptions

InvalidArgumentException When command name given is empty

in Command at line 424
public string getName()

Returns the command name.

Return Value

string The command name

in Command at line 438
public Command setDescription(string $description)

Sets the description for the command.

Parameters

string $description The description for the command

Return Value

Command The current instance

in Command at line 452
public string getDescription()

Returns the description for the command.

Return Value

string The description for the command

in Command at line 466
public Command setHelp(string $help)

Sets the help for the command.

Parameters

string $help The help for the command

Return Value

Command The current instance

in Command at line 480
public string getHelp()

Returns the help for the command.

Return Value

string The help for the command

in Command at line 491
public string getProcessedHelp()

Returns the processed help for the command replacing the %command.name% and %command.full_name% patterns with the real values dynamically.

Return Value

string The processed help for the command

in Command at line 516
public Command setAliases(array $aliases)

Sets the aliases for the command.

Parameters

array $aliases An array of aliases for the command

Return Value

Command The current instance

in Command at line 534
public array getAliases()

Returns the aliases for the command.

Return Value

array An array of aliases for the command

in Command at line 544
public string getSynopsis()

Returns the synopsis for the command.

Return Value

string The synopsis

in Command at line 564
public mixed getHelper(string $name)

Gets a helper instance by name.

Parameters

string $name The helper name

Return Value

mixed The helper value

Exceptions

InvalidArgumentException if the helper is not defined

in Command at line 576
public string asText()

Returns a text representation of the command.

Return Value

string A string representing the command

in Command at line 592
public string|DOMDocument asXml(Boolean $asDom = false)

Returns an XML representation of the command.

Parameters

Boolean $asDom Whether to return a DOM or an XML string

Return Value

string|DOMDocument An XML string representing the command

at line 65
public setCommand(Command $command)

Sets the command

Parameters

Command $command The command to set