__construct()

__construct(string  $name = null) 

Constructor.

Parameters

Throws

LogicException

When the command name is empty

ignoreValidationErrors()

ignoreValidationErrors() 

Ignores validation errors.

This is mainly useful for the help command.

setApplication()

setApplication(\Symfony\Component\Console\Application  $application = null) 

Sets the application instance for this command.

Parameters

setHelperSet()

setHelperSet(\Symfony\Component\Console\Helper\HelperSet  $helperSet) 

Sets the helper set.

Parameters

getHelperSet()

getHelperSet() : \Symfony\Component\Console\Helper\HelperSet

Gets the helper set.

Returns

A HelperSet instance

getApplication()

getApplication() : \Symfony\Component\Console\Application

Gets the application instance for this command.

Returns

An Application instance

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

run()

run(\Symfony\Component\Console\Input\InputInterface  $input, \Symfony\Component\Console\Output\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

setCode()

setCode(\Closure  $code) : \Symfony\Component\Console\Command\Command

Sets the code to execute when running this command.

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

Parameters

Returns

The current instance

setDefinition()

setDefinition(array|\Symfony\Component\Console\Input\InputDefinition  $definition) : \Symfony\Component\Console\Command\Command

Sets an array of argument and option instances.

Parameters

Returns

The current instance

getDefinition()

getDefinition() : \Symfony\Component\Console\Input\InputDefinition

Gets the InputDefinition attached to this Command.

Returns

An InputDefinition instance

addArgument()

addArgument(string  $name, integer  $mode = null, string  $description = '', mixed  $default = null) : \Symfony\Component\Console\Command\Command

Adds an argument.

Parameters

Returns

The current instance

addOption()

addOption(string  $name, string  $shortcut = null, integer  $mode = null, string  $description = '', mixed  $default = null) : \Symfony\Component\Console\Command\Command

Adds an option.

Parameters

Returns

The current instance

setName()

setName(string  $name) : \Symfony\Component\Console\Command\Command

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

Throws

InvalidArgumentException

When command name given is empty

Returns

The current instance

getName()

getName() : string

Returns the command name.

Returns

The command name

setDescription()

setDescription(string  $description) : \Symfony\Component\Console\Command\Command

Sets the description for the command.

Parameters

Returns

The current instance

getDescription()

getDescription() : string

Returns the description for the command.

Returns

The description for the command

setHelp()

setHelp(string  $help) : \Symfony\Component\Console\Command\Command

Sets the help for the command.

Parameters

Returns

The current instance

getHelp()

getHelp() : string

Returns the help for the command.

Returns

The help for the command

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

setAliases()

setAliases(array  $aliases) : \Symfony\Component\Console\Command\Command

Sets the aliases for the command.

Parameters

Returns

The current instance

getAliases()

getAliases() : array

Returns the aliases for the command.

Returns

An array of aliases for the command

getSynopsis()

getSynopsis() : string

Returns the synopsis for the command.

Returns

The synopsis

getHelper()

getHelper(string  $name) : mixed

Gets a helper instance by name.

Parameters

Throws

InvalidArgumentException

if the helper is not defined

Returns

The helper value

asText()

asText() : string

Returns a text representation of the command.

Returns

A string representing the command

asXml()

asXml(Boolean  $asDom = false) : string|\Symfony\Component\Console\Command\DOMDocument

Returns an XML representation of the command.

Parameters

Returns

An XML string representing the command

configure()

configure() 

Configures the current command.

execute()

execute(\Symfony\Component\Console\Input\InputInterface  $input, \Symfony\Component\Console\Output\OutputInterface  $output) : integer

Executes the current command.

This method is not abstract because you can use this class as a concrete class. In this case, instead of defining the execute() method, you set the code to execute by passing a Closure to the setCode() method.

Parameters

Returns

0 if everything went fine, or an error code

interact()

interact(\Symfony\Component\Console\Input\InputInterface  $input, \Symfony\Component\Console\Output\OutputInterface  $output) 

Interacts with the user.

Parameters

initialize()

initialize(\Symfony\Component\Console\Input\InputInterface  $input, \Symfony\Component\Console\Output\OutputInterface  $output) 

Initializes the command just after the input has been validated.

This is mainly useful when a lot of commands extends one main command where some things need to be initialized based on the input arguments and options.

Parameters

getNativeDefinition()

getNativeDefinition() : \Symfony\Component\Console\Input\InputDefinition

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.

Returns

An InputDefinition instance

mergeApplicationDefinition()

mergeApplicationDefinition() 

Merges the application definition with the command definition.

validateName()

validateName(  $name) 

Parameters

createDefinition()

createDefinition()