\app\framework\Component\Console\CommandHelpCommand

__construct()

__construct(  $name = null) 

Command constructor.

Parameters

isEnabled()

isEnabled() : boolean

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.

Returns

getKernel()

getKernel() : mixed

Returns

setKernel()

setKernel(mixed  $kernel) 

Parameters

run()

run(\app\framework\Component\Console\Input\InputInterface  $input, \app\framework\Component\Console\Output\ConsoleOutput  $output) : integer

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

Throws

\Exception

Returns

getProcessedHelp()

getProcessedHelp() : string

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

Returns

The processed help for the command

setCode()

setCode(callable  $code) : $this

Sets the code to execute when running this command.

If this method is used, it ov

Parameters

Throws

\ReflectionException

Returns

getName()

getName() : string

Returns

setName()

setName(string  $name) : $this

Parameters

Returns

getSignature()

getSignature() : string

Returns

setSignature()

setSignature(string  $signature) 

Parameters

setHidden()

setHidden(boolean  $hidden) : \app\framework\Component\Console\Command\Command

Parameters

Returns

The current instance

isHidden()

isHidden() : boolean

Returns

whether the command should be publicly shown or not

getDescription()

getDescription() : string

Returns

setDescription()

setDescription(string  $description) : $this

Parameters

Returns

getNativeDefinition()

getNativeDefinition() : \app\framework\Component\Console\Input\InputDefinition

Gets the InputDefinition to be used to create 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.

Returns

An InputDefinition instance

getHelp()

getHelp() : string

Returns

setHelp()

setHelp(string  $help) 

Parameters

setDefinition()

setDefinition(array|\app\framework\Component\Console\Input\InputDefinition  $definition) : $this

Sets an array of argument and option instances.

Parameters

Returns

getDefinition()

getDefinition() : \app\framework\Component\Console\Input\InputDefinition

Gets the InputDefinition attached to this Command.

Returns

An InputDefinition instance

getAliases()

getAliases() : array

Returns the aliases for the command.

Returns

An array of aliases for the command

setCommand()

setCommand(\app\framework\Component\Console\Command\Command  $command) 

Parameters

configure()

configure() 

Configures the current command.

interact()

interact(\app\framework\Component\Console\Input\InputInterface  $input) 

Interacts with the user.

This method is executed before the InputDefinition is validated. This means that this is the only place where the command can interactively ask for values of missing required arguments.

Parameters

execute()

execute(\app\framework\Component\Console\Input\InputInterface  $input, \app\framework\Component\Console\Output\ConsoleOutput  $output) 

Parameters

validateName()

validateName(string  $name) 

Validates a command name

It must be non-empty and parts can optionally be separated by ":".

Parameters

Throws

\InvalidArgumentException

When the name is invalid