Command-line point:destination class
- author Antoine Corcy
Constants |
public Symfony |
public Symfony |
public Symfony |
Methods |
public Symfony\Component\Console\Command\Command::__construct(?string $name = NULL)
|
public Symfony\Component\Console\Command\Command::addArgument(string $name, ?int $mode = NULL, string $description = '', ?mixed $default = NULL, Closure|array $suggestedValues = []) : static Adds an argument.
|
public Symfony\Component\Console\Command\Command::addOption(string $name, array|string|?null $shortcut = NULL, ?int $mode = NULL, string $description = '', ?mixed $default = NULL, Closure|array $suggestedValues = []) : static Adds an option.
|
public Symfony\Component\Console\Command\Command::addUsage(string $usage) : static Add a command usage example, it'll be prefixed with the command name.
|
public Symfony\Component\Console\Command\Command::complete(Symfony Supplies suggestions when resolving possible completion options for input (e.g. option or argument). |
public Symfony\Component\Console\Command\Command::getAliases() : array Returns the aliases for the command. |
public Symfony\Component\Console\Command\Command::getApplication() : ?Symfony Gets the application instance for this command. |
public static Symfony\Component\Console\Command\Command::getDefaultDescription() : ?string |
public static Symfony\Component\Console\Command\Command::getDefaultName() : ?string |
public Symfony\Component\Console\Command\Command::getDefinition() : Symfony Gets the InputDefinition attached to this Command. |
public Symfony\Component\Console\Command\Command::getDescription() : string Returns the description for the command. |
public Symfony\Component\Console\Command\Command::getHelp() : string Returns the help for the command. |
public Symfony\Component\Console\Command\Command::getHelper(string $name) : Symfony Gets a helper instance by name.
|
public Symfony\Component\Console\Command\Command::getHelperSet() : ?Symfony Gets the helper set. |
public Symfony\Component\Console\Command\Command::getName() : ?string Returns the command name. |
public Symfony\Component\Console\Command\Command::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 Symfony\Component\Console\Command\Command::getProcessedHelp() : string Returns the processed help for the command replacing the %command.name% and %command.full_name% patterns with the real values dynamically. |
public Symfony\Component\Console\Command\Command::getSynopsis(bool $short = false) : string Returns the synopsis for the command.
|
public Symfony\Component\Console\Command\Command::getUsages() : array Returns alternative usages of the command. |
public Symfony\Component\Console\Command\Command::ignoreValidationErrors() : void Ignores validation errors. This is mainly useful for the help command. |
public Symfony\Component\Console\Command\Command::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 Symfony\Component\Console\Command\Command::isHidden() : bool
|
public Symfony\Component\Console\Command\Command::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 Symfony\Component\Console\Command\Command::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 Symfony\Component\Console\Command\Command::setAliases(iterable $aliases) : static Sets the aliases for the command.
|
public Symfony\Component\Console\Command\Command::setApplication(?Symfony |
public Symfony\Component\Console\Command\Command::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 Symfony\Component\Console\Command\Command::setDefinition(Symfony Sets an array of argument and option instances.
|
public Symfony\Component\Console\Command\Command::setDescription(string $description) : static Sets the description for the command.
|
public Symfony\Component\Console\Command\Command::setHelp(string $help) : static Sets the help for the command.
|
public Symfony\Component\Console\Command\Command::setHelperSet(Symfony |
public Symfony\Component\Console\Command\Command::setHidden(bool $hidden = true) : static
|
public Symfony\Component\Console\Command\Command::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 Symfony\Component\Console\Command\Command::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() |
protected execute(Symfony |
protected Symfony\Component\Console\Command\Command::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 Symfony\Component\Console\Command\Command::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.
|
Methods |
public static Symfony\Component\Console\Command\Command::getDefaultDescription() : ?string |
public static Symfony\Component\Console\Command\Command::getDefaultName() : ?string |