Documentation

ListCommand extends Command
in package

Application

ListCommand displays the list of all available commands for the application.

Properties

$aliases : mixed
$application : mixed
$applicationDefinitionMerged : mixed
$applicationDefinitionMergedWithArgs : mixed
$code : mixed
$definition : mixed
$description : mixed
$help : mixed
$helperSet : mixed
$hidden : mixed
$ignoreValidationErrors : mixed
$name : mixed
$processTitle : mixed
$synopsis : mixed
$usages : mixed

Methods

__construct() : mixed: Constructor.
addArgument() : $this: Adds an argument.
addOption() : $this: Adds an option.
addUsage() : $this: Add a command usage example.
getAliases() : array<string|int, mixed>: Returns the aliases for the command.
getApplication() : Application: Gets the application instance for this command.
getDefinition() : InputDefinition: Gets the InputDefinition attached to this Command.
getDescription() : string: Returns the description for the command.
getHelp() : string: Returns the help for the command.
getHelper() : mixed: Gets a helper instance by name.
getHelperSet() : HelperSet: Gets the helper set.
getName() : string: Returns the command name.
getNativeDefinition() : InputDefinition: Gets the InputDefinition to be used to create representations of this Command.
getProcessedHelp() : string: Returns the processed help for the command replacing the %command.name% and %command.full_name% patterns with the real values dynamically.
getSynopsis() : string: Returns the synopsis for the command.
getUsages() : array<string|int, mixed>: Returns alternative usages of the command.
ignoreValidationErrors() : mixed: Ignores validation errors.
isEnabled() : bool: Checks whether the command is enabled or not in the current environment.
isHidden() : bool
mergeApplicationDefinition() : mixed: Merges the application definition with the command definition.
run() : int: Runs the command.
setAliases() : $this: Sets the aliases for the command.
setApplication() : mixed: Sets the application instance for this command.
setCode() : $this: Sets the code to execute when running this command.
setDefinition() : $this: Sets an array of argument and option instances.
setDescription() : $this: Sets the description for the command.
setHelp() : $this: Sets the help for the command.
setHelperSet() : mixed: Sets the helper set.
setHidden() : Command
setName() : $this: Sets the name of the command.
setProcessTitle() : $this: Sets the process title of the command.
configure() : mixed: Configures the current command.
execute() : null|int: Executes the current command.
initialize() : mixed: Initializes the command just after the input has been validated.
interact() : mixed: Interacts with the user.
createDefinition() : mixed: {@inheritdoc}
validateName() : mixed: Validates a command name.

$aliases


    private
        mixed
    $aliases
     = array()

$application


    private
        mixed
    $application

$applicationDefinitionMerged


    private
        mixed
    $applicationDefinitionMerged
     = false

$applicationDefinitionMergedWithArgs


    private
        mixed
    $applicationDefinitionMergedWithArgs
     = false

$code


    private
        mixed
    $code

$definition


    private
        mixed
    $definition

$description


    private
        mixed
    $description

$help


    private
        mixed
    $help

$helperSet


    private
        mixed
    $helperSet

$hidden


    private
        mixed
    $hidden
     = false

$ignoreValidationErrors


    private
        mixed
    $ignoreValidationErrors
     = false

$name


    private
        mixed
    $name

$processTitle


    private
        mixed
    $processTitle

$synopsis


    private
        mixed
    $synopsis
     = array()

$usages


    private
        mixed
    $usages
     = array()

__construct()

Constructor.


    public
                    __construct([string|null $name = null ]) : mixed

Parameters

$name : string|null = null: The name of the command; passing null means it must be set in configure()

addArgument()

Adds an argument.


    public
                    addArgument(string $name[, int $mode = null ][, string $description = '' ][, mixed $default = null ]) : $this

Parameters

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

Return values

$this

addOption()

Adds an option.


    public
                    addOption(string $name[, string $shortcut = null ][, int $mode = null ][, string $description = '' ][, mixed $default = null ]) : $this

Parameters

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

Return values

$this

addUsage()

Add a command usage example.


    public
                    addUsage(string $usage) : $this

Parameters

$usage : string: The usage, it'll be prefixed with the command name

Return values

$this

getAliases()

Returns the aliases for the command.


    public
                    getAliases() : array<string|int, mixed>

Return values

array<string|int, mixed> —

An array of aliases for the command

getApplication()

Gets the application instance for this command.


    public
                    getApplication() : Application

Return values

Application —

An Application instance

getDefinition()

Gets the InputDefinition attached to this Command.


    public
                    getDefinition() : InputDefinition

Return values

InputDefinition —

An InputDefinition instance

getDescription()

Returns the description for the command.


    public
                    getDescription() : string

Return values

string —

The description for the command

getHelp()

Returns the help for the command.


    public
                    getHelp() : string

Return values

string —

The help for the command

getHelper()

Gets a helper instance by name.


    public
                    getHelper(string $name) : mixed

Parameters

$name : string: The helper name

Return values

mixed —

The helper value

getHelperSet()

Gets the helper set.


    public
                    getHelperSet() : HelperSet

Return values

HelperSet —

A HelperSet instance

getName()

Returns the command name.


    public
                    getName() : string

Return values

string —

The command name

getNativeDefinition()

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


    public
                    getNativeDefinition() : InputDefinition

Return values

InputDefinition —

An InputDefinition instance

getProcessedHelp()

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


    public
                    getProcessedHelp() : string

Return values

string —

The processed help for the command

getSynopsis()

Returns the synopsis for the command.


    public
                    getSynopsis([bool $short = false ]) : string

Parameters

$short : bool = false: Whether to show the short version of the synopsis (with options folded) or not

Return values

string —

The synopsis

getUsages()

Returns alternative usages of the command.


    public
                    getUsages() : array<string|int, mixed>

Return values

array<string|int, mixed>

ignoreValidationErrors()

Ignores validation errors.


    public
                    ignoreValidationErrors() : mixed

This is mainly useful for the help command.

isEnabled()

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


    public
                    isEnabled() : bool

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

Return values

bool

isHidden()


    public
                    isHidden() : bool

Return values

bool —

Whether the command should be publicly shown or not.

mergeApplicationDefinition()

Merges the application definition with the command definition.


    public
                    mergeApplicationDefinition([bool $mergeArgs = true ]) : mixed

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

Parameters

$mergeArgs : bool = true: Whether to merge or not the Application definition arguments to Command definition arguments

run()

Runs the command.


    public
                    run(InputInterface $input, OutputInterface $output) : int

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

Parameters

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

Return values

int —

The command exit code

setAliases()

Sets the aliases for the command.


    public
                    setAliases(array<string|int, string> $aliases) : $this

Parameters

$aliases : array<string|int, string>: An array of aliases for the command

Return values

$this

setApplication()

Sets the application instance for this command.


    public
                    setApplication([Application $application = null ]) : mixed

Parameters

$application : Application = null: An Application instance

setCode()

Sets the code to execute when running this command.


    public
                    setCode(callable $code) : $this

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

Parameters

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

Return values

$this

setDefinition()

Sets an array of argument and option instances.


    public
                    setDefinition(array<string|int, mixed>|InputDefinition $definition) : $this

Parameters

$definition : array<string|int, mixed>|InputDefinition: An array of argument and option instances or a definition instance

Return values

$this

setDescription()

Sets the description for the command.


    public
                    setDescription(string $description) : $this

Parameters

$description : string: The description for the command

Return values

$this

setHelp()

Sets the help for the command.


    public
                    setHelp(string $help) : $this

Parameters

$help : string: The help for the command

Return values

$this

setHelperSet()

Sets the helper set.


    public
                    setHelperSet(HelperSet $helperSet) : mixed

Parameters

$helperSet : HelperSet: A HelperSet instance

setHidden()


    public
                    setHidden(bool $hidden) : Command

Parameters

$hidden : bool: Whether or not the command should be hidden from the list of commands

Return values

Command —

The current instance

setName()

Sets the name of the command.


    public
                    setName(string $name) : $this

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

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

Parameters

$name : string: The command name

Return values

$this

setProcessTitle()

Sets the process title of the command.


    public
                    setProcessTitle(string $title) : $this

This feature should be used only when creating a long process command, like a daemon.

PHP 5.5+ or the proctitle PECL library is required

Parameters

$title : string: The process title

Return values

$this

configure()

Configures the current command.


    protected
                    configure() : mixed

execute()

Executes the current command.


    protected
                    execute(InputInterface $input, OutputInterface $output) : null|int

Parameters

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

Return values

null|int —

null or 0 if everything went fine, or an error code

initialize()

Initializes the command just after the input has been validated.


    protected
                    initialize(InputInterface $input, OutputInterface $output) : mixed

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

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

interact()

Interacts with the user.


    protected
                    interact(InputInterface $input, OutputInterface $output) : mixed

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

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

createDefinition()

{@inheritdoc}


    private
                    createDefinition() : mixed

validateName()

Validates a command name.


    private
                    validateName(string $name) : mixed

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

Parameters

$name : string

ListCommand extends Command in package Application

Tags

Table of Contents

Properties

Methods

Properties

$aliases

$application

$applicationDefinitionMerged

$applicationDefinitionMergedWithArgs

$code

$definition

$description

$help

$helperSet

$hidden

$ignoreValidationErrors

$name

$processTitle

$synopsis

$usages

Methods

__construct()

Parameters

Tags

addArgument()

Parameters

Return values

addOption()

Parameters

Return values

addUsage()

Parameters

Return values

getAliases()

Return values

getApplication()

Return values

getDefinition()

Return values

getDescription()

Return values

getHelp()

Return values

getHelper()

Parameters

Tags

Return values

getHelperSet()

Return values

getName()

Return values

getNativeDefinition()

Return values

getProcessedHelp()

Return values

getSynopsis()

Parameters

Return values

getUsages()

Return values

ignoreValidationErrors()

isEnabled()

Return values

isHidden()

Return values

mergeApplicationDefinition()

Parameters

run()

Parameters

Tags

Return values

setAliases()

Parameters

Tags

Return values

setApplication()

Parameters

setCode()

Parameters

ListCommand extends Command
in package

Application