Référence de la classe Command

Graphe d'héritage de Command:

Fonctions membres publiques
	__construct (string $name=null)
	ignoreValidationErrors ()
	setApplication (Application $application=null)
	setHelperSet (HelperSet $helperSet)
	getHelperSet ()
	getApplication ()
	isEnabled ()
	run (InputInterface $input, OutputInterface $output)
	complete (CompletionInput $input, CompletionSuggestions $suggestions)
	setCode (callable $code)
	mergeApplicationDefinition (bool $mergeArgs=true)
	setDefinition ($definition)
	getDefinition ()
	getNativeDefinition ()
	addArgument (string $name, int $mode=null, string $description='', $default=null)
	addOption (string $name, $shortcut=null, int $mode=null, string $description='', $default=null)
	setName (string $name)
	setProcessTitle (string $title)
	getName ()
	setHidden (bool $hidden)
	isHidden ()
	setDescription (string $description)
	getDescription ()
	setHelp (string $help)
	getHelp ()
	getProcessedHelp ()
	setAliases (iterable $aliases)
	getAliases ()
	getSynopsis (bool $short=false)
	addUsage (string $usage)
	getUsages ()
	getHelper (string $name)

Fonctions membres publiques statiques
static	getDefaultName ()
static	getDefaultDescription ()

Champs de données
const	SUCCESS = 0
const	FAILURE = 1
const	INVALID = 2

Fonctions membres protégées
	configure ()
	execute (InputInterface $input, OutputInterface $output)
	interact (InputInterface $input, OutputInterface $output)
	initialize (InputInterface $input, OutputInterface $output)

Attributs protégés statiques
static	$defaultName
static	$defaultDescription

Fonctions membres privées
	validateName (string $name)

Attributs privés
	$application
	$name
	$processTitle
	$aliases = []
	$definition
	$hidden = false
	$help = ''
	$description = ''
	$fullDefinition
	$ignoreValidationErrors = false
	$code
	$synopsis = []
	$usages = []
	$helperSet

Description détaillée

Base class for all commands.

Auteur

Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Documentation des constructeurs et destructeur

__construct()

__construct

(

string

$name = null

)

Paramètres

string | null

$name

The name of the command; passing null means it must be set in configure()

Exceptions

LogicException

When the command name is empty

Références Command\$aliases, Command\$name, Command\configure(), description, null, Command\setAliases(), Command\setDescription(), Command\setHidden(), et Command\setName().

Documentation des fonctions membres

addArgument()

addArgument	(	string	$name,
		int	$mode = null,
		string	$description = '',
			$default = null
	)

Adds an argument.

Paramètres

int | null	$mode	The argument mode: InputArgument::REQUIRED or InputArgument::OPTIONAL
mixed	$default	The default value (for InputArgument::OPTIONAL mode only)

Exceptions

InvalidArgumentException

When argument mode is not valid

Renvoie

$this

Références $default, Command\$description, $mode, Command\$name, $this, et null.

addOption()

addOption	(	string	$name,
			$shortcut = null,
		int	$mode = null,
		string	$description = '',
			$default = null
	)

Adds an option.

Paramètres

string | array | null	$shortcut	The shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts
int | null	$mode	The option mode: One of the InputOption::VALUE_* constants
mixed	$default	The default value (must be null for InputOption::VALUE_NONE)

Exceptions

InvalidArgumentException

If option mode is invalid or incompatible

Renvoie

$this

Références $default, Command\$description, $mode, Command\$name, $this, et null.

addUsage()

addUsage

(

string

$usage

)

Add a command usage example, it'll be prefixed with the command name.

Renvoie

$this

Références $this, et name.

complete()

complete	(	CompletionInput	$input,
		CompletionSuggestions	$suggestions
	)

Adds suggestions to $suggestions for the current completion input (e.g. option or argument).

configure()

configure ( )

protected

Configures the current command.

Référencé par Command\__construct().

execute()

execute ( InputInterface  $input, OutputInterface  $output  )

protected

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.

Renvoie

int 0 if everything went fine, or an exit code

Exceptions

LogicException

When this abstract method is not implemented

Voir également

setCode()

Référencé par Command\run().

getAliases()

getAliases

(

)

Returns the aliases for the command.

Renvoie

array

Références Command\$aliases.

Référencé par Application\add(), MarkdownDescriptor\describeCommand(), TextDescriptor\describeCommand(), LazyCommand\getCommand(), TextDescriptor\getCommandAliasesText(), JsonDescriptor\getCommandData(), et XmlDescriptor\getCommandDocument().

getApplication()

getApplication

(

)

Gets the application instance for this command.

Renvoie

Application|null

Références Command\$application.

Référencé par HelpCommand\complete(), CompleteCommand\createCompletionInput(), HelpCommand\execute(), DumpCompletionCommand\execute(), CompleteCommand\findCommand(), et LazyCommand\getCommand().

getDefaultDescription()

static getDefaultDescription ( )

static

Références $class, $r, class, Fig\Link\getAttributes(), et null.

getDefaultName()

static getDefaultName ( )

static

Renvoie

string|null

Références $class, $r, class, Fig\Link\getAttributes(), et null.

getDefinition()

getDefinition

(

)

Gets the InputDefinition attached to this Command.

Renvoie

InputDefinition

Références Command\getNativeDefinition().

Référencé par Application\add(), CompleteCommand\createCompletionInput(), MarkdownDescriptor\describeCommand(), TextDescriptor\describeCommand(), Application\doRunCommand(), JsonDescriptor\getCommandData(), XmlDescriptor\getCommandDocument(), et Command\run().

getDescription()

getDescription

(

)

Returns the description for the command.

Renvoie

string

Références Command\$description.

Référencé par MarkdownDescriptor\describeCommand(), TextDescriptor\describeCommand(), LazyCommand\getCommand(), JsonDescriptor\getCommandData(), XmlDescriptor\getCommandDocument(), et Command\getProcessedHelp().

getHelp()

getHelp

(

)

Returns the help for the command.

Renvoie

string

Références Command\$help.

Référencé par Command\getProcessedHelp().

getHelper()

getHelper

(

string

$name

)

Gets a helper instance by name.

Renvoie

mixed

Exceptions

LogicException	if no HelperSet is defined
InvalidArgumentException	if the helper is not defined

Références Command\$name, et null.

getHelperSet()

getHelperSet

(

)

Gets the helper set.

Renvoie

HelperSet|null

Références Command\$helperSet.

Référencé par Application\doRunCommand(), et LazyCommand\getCommand().

getName()

getName

(

)

Returns the command name.

Renvoie

string|null

Références Command\$name.

Référencé par Application\add(), Application\complete(), MarkdownDescriptor\describeCommand(), LazyCommand\getCommand(), JsonDescriptor\getCommandData(), XmlDescriptor\getCommandDocument(), Symfony\Component\Console\Command\lock(), SingleCommandApplication\run(), et Command\run().

getNativeDefinition()

getNativeDefinition

(

)

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.

Renvoie

InputDefinition

Références Command\$definition, class, et null.

Référencé par Command\getDefinition().

getProcessedHelp()

getProcessedHelp

(

)

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

Renvoie

string

Références Command\$name, Command\getDescription(), et Command\getHelp().

Référencé par MarkdownDescriptor\describeCommand(), TextDescriptor\describeCommand(), JsonDescriptor\getCommandData(), et XmlDescriptor\getCommandDocument().

getSynopsis()

getSynopsis

(

bool

$short = false

)

Returns the synopsis for the command.

Paramètres

bool

$short

Whether to show the short version of the synopsis (with options folded) or not

Renvoie

string

Références $key, et name.

Référencé par MarkdownDescriptor\describeCommand(), TextDescriptor\describeCommand(), JsonDescriptor\getCommandData(), et XmlDescriptor\getCommandDocument().

getUsages()

getUsages

(

)

Returns alternative usages of the command.

Renvoie

array

Références Command\$usages.

Référencé par MarkdownDescriptor\describeCommand(), TextDescriptor\describeCommand(), JsonDescriptor\getCommandData(), et XmlDescriptor\getCommandDocument().

ignoreValidationErrors()

ignoreValidationErrors

(

)

Ignores validation errors.

This is mainly useful for the help command.

Référencé par HelpCommand\configure(), et Command\run().

initialize()

initialize ( InputInterface  $input, OutputInterface  $output  )

protected

Initializes the command after the input has been bound and before the input is 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.

Voir également

InputInterface::bind()

InputInterface::validate()

Référencé par Command\run().

interact()

interact ( InputInterface  $input, OutputInterface  $output  )

protected

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.

Référencé par Command\run().

isEnabled()

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 cannot run properly under the current conditions.

Renvoie

bool

Référencé par Application\add().

isHidden()

isHidden

(

)

Renvoie

bool whether the command should be publicly shown or not

Références Command\$hidden.

Référencé par Application\complete(), LazyCommand\getCommand(), JsonDescriptor\getCommandData(), et XmlDescriptor\getCommandDocument().

mergeApplicationDefinition()

mergeApplicationDefinition

(

bool

$mergeArgs = true

)

Merges the application definition with the command definition.

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

Paramètres

bool

$mergeArgs

Whether to merge or not the Application definition arguments to Command definition arguments

Références null.

Référencé par MarkdownDescriptor\describeCommand(), TextDescriptor\describeCommand(), Application\doRunCommand(), JsonDescriptor\getCommandData(), XmlDescriptor\getCommandDocument(), et Command\run().

run()

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.

Renvoie

int The command exit code

Exceptions

Références Command\$code, $input, $output, Symfony\Component\Console\Tester\$statusCode, InputInterface\bind(), class, code, elseif, Command\execute(), Command\getDefinition(), Command\getName(), Command\ignoreValidationErrors(), Command\initialize(), Command\interact(), Command\mergeApplicationDefinition(), null, InputInterface\validate(), et OutputInterface\VERBOSITY_VERY_VERBOSE.

Référencé par Application\doRunCommand().

setAliases()

setAliases

(

iterable

$aliases

)

Sets the aliases for the command.

Paramètres

string[]

$aliases An array of aliases for the command

Renvoie

$this

Exceptions

InvalidArgumentException

When an alias is invalid

Références Command\$aliases, $list, $this, et Command\validateName().

Référencé par Command\__construct().

setApplication()

setApplication

(

Application

$application = null

)

Références Command\$application, null, et Command\setHelperSet().

Référencé par Application\add().

setCode()

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.

Paramètres

callable

$code

A callable(InputInterface $input, OutputInterface $output)

Renvoie

$this

Exceptions

InvalidArgumentException

Voir également

execute()

Références $c, Command\$code, $r, $this, code, et null.

setDefinition()

setDefinition

(

$definition

)

Sets an array of argument and option instances.

Paramètres

array | InputDefinition

$definition

An array of argument and option instances or a definition instance

Renvoie

$this

Références Command\$definition, $this, et null.

setDescription()

setDescription

(

string

$description

)

Sets the description for the command.

Renvoie

$this

Références Command\$description, $this, et description.

Référencé par Command\__construct().

setHelp()

setHelp

(

string

$help

)

Sets the help for the command.

Renvoie

$this

Références Command\$help, et $this.

setHelperSet()

setHelperSet

(

HelperSet

$helperSet

)

Références Command\$helperSet.

Référencé par Command\setApplication().

setHidden()

setHidden

(

bool

$hidden

)

Paramètres

bool

$hidden

Whether or not the command should be hidden from the list of commands The default value will be true in Symfony 6.0

Renvoie

$this

since Symfony 5.1

Références Command\$hidden, et $this.

Référencé par Command\__construct().

setName()

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');

Renvoie

$this

Exceptions

InvalidArgumentException

When the name is invalid

Références Command\$name, $this, name, et Command\validateName().

Référencé par LazyCommand\__construct(), Command\__construct(), et SingleCommandApplication\run().

setProcessTitle()

setProcessTitle

(

string

$title

)

Sets the process title of the command.

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

Renvoie

$this

Références $this, et $title.

validateName()

validateName ( string  $name )

private

Validates a command name.

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

Exceptions

InvalidArgumentException

When the name is invalid

Références Command\$name.

Référencé par Command\setAliases(), et Command\setName().

Documentation des champs

$aliases

$aliases = []

private

Référencé par LazyCommand\__construct(), Command\__construct(), Command\getAliases(), et Command\setAliases().

$application

$application

private

Référencé par Command\getApplication(), SingleCommandApplication\run(), LazyCommand\setApplication(), et Command\setApplication().

$code

$code

private

Référencé par Command\run(), et Command\setCode().

$defaultDescription

$defaultDescription

staticprotected

$defaultName

$defaultName

staticprotected

$definition

$definition

private

Référencé par Command\getNativeDefinition(), LazyCommand\setDefinition(), et Command\setDefinition().

$description

$description = ''

private

Référencé par LazyCommand\__construct(), LazyCommand\addArgument(), Command\addArgument(), LazyCommand\addOption(), Command\addOption(), Command\getDescription(), et Command\setDescription().

$fullDefinition

$fullDefinition

private

$help

$help = ''

private

Référencé par Command\getHelp(), et Command\setHelp().

$helperSet

$helperSet

private

Référencé par Command\getHelperSet(), LazyCommand\setHelperSet(), et Command\setHelperSet().

$hidden

$hidden = false

private

Référencé par Command\isHidden(), et Command\setHidden().

$ignoreValidationErrors

$ignoreValidationErrors = false

private

$name

$name

private

Référencé par LintCommand\__construct(), Command\__construct(), Command\addArgument(), Command\addOption(), Command\getHelper(), Command\getName(), Command\getProcessedHelp(), Symfony\Component\Console\Command\lock(), Command\setName(), et Command\validateName().

$processTitle

$processTitle

private

$synopsis

$synopsis = []

private

$usages

$usages = []

private

Référencé par Command\getUsages().

FAILURE

const FAILURE = 1

Référencé par CommandIsSuccessful\additionalFailureDescription(), SessionGcCommand\doExecute(), SessionMetadataGcCommand\doExecute(), ChangeUserPasswordCommand\doExecute(), DeleteUserCommand\doExecute(), RemoveUserFromGroupCommand\doExecute(), AddUserToGroupCommand\doExecute(), AddUserCommand\doExecute(), et ExtensionDiscoverInstallCommand\doExecute().

INVALID

const INVALID = 2

Référencé par CommandIsSuccessful\additionalFailureDescription().

SUCCESS

const SUCCESS = 0

Référencé par CheckUpdatesCommand\doExecute(), RemoveOldFilesCommand\doExecute(), SessionGcCommand\doExecute(), ListUserCommand\doExecute(), ChangeUserPasswordCommand\doExecute(), ExtensionDiscoverListCommand\doExecute(), DeleteUserCommand\doExecute(), RemoveUserFromGroupCommand\doExecute(), AddUserToGroupCommand\doExecute(), CheckJoomlaUpdatesCommand\doExecute(), AddUserCommand\doExecute(), ExtensionDiscoverCommand\doExecute(), FinderIndexCommand\doExecute(), ExtensionDiscoverInstallCommand\doExecute(), ExtensionsListCommand\doExecute(), et CommandIsSuccessful\matches().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Command.php