Base class for all commands.
- author Fabien Potencier
- Children
Constants |
public Symfony |
public Symfony |
public Symfony |
Methods |
public __construct(?string $name = NULL)
|
public addArgument(string $name, ?int $mode = NULL, string $description = '', ?mixed $default = NULL) : static Adds an argument.
|
public addOption(string $name, array|string|?null $shortcut = NULL, ?int $mode = NULL, string $description = '', ?mixed $default = NULL) : static Adds an option.
|
public addUsage(string $usage) : static Add a command usage example, it'll be prefixed with the command name.
|
public complete(Symfony Adds suggestions to $suggestions for the current completion input (e.g. option or argument). |
public getAliases() : array Returns the aliases for the command. |
public getApplication() : ?Symfony Gets the application instance for this command. |
public static getDefaultDescription() : ?string |
public static getDefaultName() : ?string |
public getDefinition() : Symfony Gets the InputDefinition attached to this Command. |
public getDescription() : string Returns the description for the command. |
public getHelp() : string Returns the help for the command. |
public getHelper(string $name) : ?mixed Gets a helper instance by name.
|
public getHelperSet() : ?Symfony Gets the helper set. |
public getName() : ?string Returns the command name. |
public getNativeDefinition() : Symfony 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 This method is not part of public API and should not be used directly. |
public getProcessedHelp() : string Returns the processed help for the command replacing the %command.name% and |
public getSynopsis(bool $short = false) : string Returns the synopsis for the command.
|
public getUsages() : array Returns alternative usages of the command. |
public ignoreValidationErrors() Ignores validation errors. This is mainly useful for the help command.
|
public 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
|
public isHidden() : bool
|
public mergeApplicationDefinition(bool $mergeArgs = true) : void Merges the application definition with the command definition. This method is not part of public API and should not be used directly.
|
public run(Symfony Runs the command. The code to execute is either defined directly with the
|
public setAliases(iterable $aliases) : static Sets the aliases for the command.
|
public setApplication(?Symfony
|
public setCode(callable $code) : static Sets the code to execute when running this command. If this method is used, it overrides the code defined
|
public setDefinition(Symfony Sets an array of argument and option instances.
|
public setDescription(string $description) : static Sets the description for the command.
|
public setHelp(string $help) : static Sets the help for the command.
|
public setHelperSet(Symfony
|
public setHidden(bool $hidden = true) : static
|
public setName(string $name) : static Sets the name of the command. This method can set both the namespace and the name if
|
public setProcessTitle(string $title) : static Sets the process title of the command. This feature should be used only when creating a long process command,
|
Properties |
protected static $defaultDescription = NULL
|
protected static $defaultName = NULL
|
Methods |
protected configure() Configures the current command.
|
protected execute(Symfony Executes the current command. This method is not abstract because you can use this class
|
protected initialize(Symfony Initializes the command after the input has been bound and before the input This is mainly useful when a lot of commands extends one main command
|
protected interact(Symfony Interacts with the user. This method is executed before the InputDefinition is validated.
|
Properties |
private array $aliases = [] |
private ?Symfony |
private ?Closure $code = NULL |
private Symfony |
private string $description = '' |
private ?Symfony |
private string $help = '' |
private ?Symfony |
private bool $hidden = false |
private bool $ignoreValidationErrors = false |
private ?string $name = NULL |
private ?string $processTitle = NULL |
private array $synopsis = [] |
private array $usages = [] |
Methods |
private validateName(string $name) : void Validates a command name. It must be non-empty and parts can optionally be separated by ":".
|
Properties |
protected static $defaultDescription = NULL
|
protected static $defaultName = NULL
|
Methods |
public static getDefaultDescription() : ?string |
public static getDefaultName() : ?string |