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, Closure|array $suggestedValues = []) : static Adds an argument.
|
public addOption(string $name, array|string|?null $shortcut = NULL, ?int $mode = NULL, string $description = '', ?mixed $default = NULL, Closure|array $suggestedValues = []) : 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 Supplies suggestions when resolving possible completion options for 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) : Symfony 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 be changed by merging with the application InputDefinition. 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 %command.full_name% patterns with the real values dynamically. |
public getSynopsis(bool $short = false) : string Returns the synopsis for the command.
|
public getUsages() : array Returns alternative usages of the command. |
public ignoreValidationErrors() : void Ignores validation errors. This is mainly useful for the help command. |
public isEnabled() : bool 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. |
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 setCode() method or by overriding the execute() method in a sub-class.
|
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 in the execute() method.
|
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 you separate them by a colon (:)
|
public setProcessTitle(string $title) : static Sets the process title of the command. This feature should be used only when creating a long process command, like a daemon.
|
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 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.
|
protected initialize(Symfony 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.
|
protected interact(Symfony 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.
|
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 ":".
|
Methods |
public static getDefaultDescription() : ?string |
public static getDefaultName() : ?string |