class ContainerAwareCommand extends Command implements ContainerAwareInterface
Command.
__construct(string|null $name = null) Constructor. | from Command | |
ignoreValidationErrors() Ignores validation errors. | from Command | |
setApplication(Application $application = null) Sets the application instance for this command. | from Command | |
setHelperSet(HelperSet $helperSet) Sets the helper set. | from Command | |
HelperSet | getHelperSet() Gets the helper set. | from Command |
Application | getApplication() Gets the application instance for this command. | from Command |
bool | isEnabled() Checks whether the command is enabled or not in the current environment. | from Command |
int | run(InputInterface $input, OutputInterface $output) Runs the command. | from Command |
Command | setCode(callable $code) Sets the code to execute when running this command. | from Command |
mergeApplicationDefinition(bool $mergeArgs = true) Merges the application definition with the command definition. | from Command | |
Command | setDefinition(array|InputDefinition $definition) Sets an array of argument and option instances. | from Command |
InputDefinition | getDefinition() Gets the InputDefinition attached to this Command. | from Command |
InputDefinition | getNativeDefinition() Gets the InputDefinition to be used to create XML and Text representations of this Command. | from Command |
Command | addArgument(string $name, int $mode = null, string $description = '', mixed $default = null) Adds an argument. | from Command |
Command | addOption(string $name, string $shortcut = null, int $mode = null, string $description = '', mixed $default = null) Adds an option. | from Command |
Command | setName(string $name) Sets the name of the command. | from Command |
Command | setProcessTitle(string $title) Sets the process title of the command. | from Command |
string | getName() Returns the command name. | from Command |
Command | setDescription(string $description) Sets the description for the command. | from Command |
string | getDescription() Returns the description for the command. | from Command |
Command | setHelp(string $help) Sets the help for the command. | from Command |
string | getHelp() Returns the help for the command. | from Command |
string | getProcessedHelp() Returns the processed help for the command replacing the %command.name% and %command.full_name% patterns with the real values dynamically. | from Command |
Command | setAliases(string[] $aliases) Sets the aliases for the command. | from Command |
array | getAliases() Returns the aliases for the command. | from Command |
string | getSynopsis(bool $short = false) Returns the synopsis for the command. | from Command |
addUsage(string $usage) Add a command usage example. | from Command | |
array | getUsages() Returns alternative usages of the command. | from Command |
mixed | getHelper(string $name) Gets a helper instance by name. | from Command |
string | asText() deprecated Returns a text representation of the command. | from Command |
string|DOMDocument | asXml(bool $asDom = false) deprecated Returns an XML representation of the command. | from Command |
setContainer(ContainerInterface $container = null) Sets the container. |
Constructor.
string|null | $name | The name of the command; passing null means it must be set in configure() |
LogicException | When the command name is empty |
Ignores validation errors.
This is mainly useful for the help command.
Sets the application instance for this command.
Application | $application | An Application instance |
Sets the helper set.
HelperSet | $helperSet | A HelperSet instance |
Gets the helper set.
HelperSet | A HelperSet instance |
Gets the application instance for this command.
Application | An Application instance |
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 can not run properly under the current conditions.
bool |
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.
InputInterface | $input | An InputInterface instance |
OutputInterface | $output | An OutputInterface instance |
int | The command exit code |
Exception |
setCode() | |
execute() |
Sets the code to execute when running this command.
If this method is used, it overrides the code defined in the execute() method.
callable | $code | A callable(InputInterface $input, OutputInterface $output) |
Command | The current instance |
InvalidArgumentException |
execute() |
Merges the application definition with the command definition.
This method is not part of public API and should not be used directly.
bool | $mergeArgs | Whether to merge or not the Application definition arguments to Command definition arguments |
Sets an array of argument and option instances.
array|InputDefinition | $definition | An array of argument and option instances or a definition instance |
Command | The current instance |
Gets the InputDefinition attached to this Command.
InputDefinition | An InputDefinition instance |
Gets the InputDefinition to be used to create XML and Text 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.
InputDefinition | An InputDefinition instance |
Adds an argument.
string | $name | The argument name |
int | $mode | The argument mode: InputArgument::REQUIRED or InputArgument::OPTIONAL |
string | $description | A description text |
mixed | $default | The default value (for InputArgument::OPTIONAL mode only) |
Command | The current instance |
Adds an option.
string | $name | The option name |
string | $shortcut | The shortcut (can be null) |
int | $mode | The option mode: One of the InputOption::VALUE_* constants |
string | $description | A description text |
mixed | $default | The default value (must be null for InputOption::VALUEREQUIRED or InputOption::VALUENONE) |
Command | The current instance |
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');
string | $name | The command name |
Command | The current instance |
InvalidArgumentException | When the name is invalid |
Sets the process title of the command.
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
string | $title | The process title |
Command | The current instance |
Returns the command name.
string | The command name |
Sets the description for the command.
string | $description | The description for the command |
Command | The current instance |
Returns the description for the command.
string | The description for the command |
Sets the help for the command.
string | $help | The help for the command |
Command | The current instance |
Returns the help for the command.
string | The help for the command |
Returns the processed help for the command replacing the %command.name% and %command.full_name% patterns with the real values dynamically.
string | The processed help for the command |
Sets the aliases for the command.
string[] | $aliases | An array of aliases for the command |
Command | The current instance |
InvalidArgumentException | When an alias is invalid |
Returns the aliases for the command.
array | An array of aliases for the command |
Returns the synopsis for the command.
bool | $short | Whether to show the short version of the synopsis (with options folded) or not |
string | The synopsis |
Add a command usage example.
string | $usage | The usage, it'll be prefixed with the command name |
Returns alternative usages of the command.
array |
Gets a helper instance by name.
string | $name | The helper name |
mixed | The helper value |
InvalidArgumentException | if the helper is not defined |
deprecated
Returns a text representation of the command.
string | A string representing the command |
deprecated
Returns an XML representation of the command.
bool | $asDom | Whether to return a DOM or an XML string |
string|DOMDocument | An XML string representing the command |
Sets the container.
ContainerInterface | $container | A ContainerInterface instance or null |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Bundle/FrameworkBundle/Command/ContainerAwareCommand.html