$defaultNamespaces
$defaultNamespaces :
handle(\app\framework\Component\Console\Input\ArgvInput $input, \app\framework\Component\Console\Output\OutputInterface $output)
Execute command and show its output if required.
| \app\framework\Component\Console\Input\ArgvInput | $input | |
| \app\framework\Component\Console\Output\OutputInterface | $output |
run(\app\framework\Component\Console\Input\InputInterface $input = null, \app\framework\Component\Console\Output\OutputInterface $output = null) : integer
Runs the current application.
| \app\framework\Component\Console\Input\InputInterface | $input | |
| \app\framework\Component\Console\Output\OutputInterface | $output |
When running fails. Bypass this when {@link setCatchExceptions()}.
0 if everything went fine, or an error code
add(\app\framework\Component\Console\Command\Command $command) : \app\framework\Component\Console\Command\Command
Adds a command.
| \app\framework\Component\Console\Command\Command | $command |
if something is not correct with the Command
| void Void if command is not enabled;
get(string $name) : \app\framework\Component\Console\Command\Command
Returns a registered command by name or alias.
| string | $name | The command name or alias |
When given command name does not exist
A Command object
find(string $name) : \app\framework\Component\Console\Command\Command
Finds a command by name
Contrary to get, this command tries to find the best match if you give it an abbreviation of a name or alias.
| string | $name | A command name |
When command name is incorrect or ambiguous
A Command instance
register(string $name) : \app\framework\Component\Console\Command\Command
Registers a new command.
| string | $name | The command name |
The newly created command
renderException(\Exception $e, \app\framework\Component\Console\Output\OutputInterface $output)
Renders a caught exception.
| \Exception | $e | |
| \app\framework\Component\Console\Output\OutputInterface | $output |
all(string $namespace = null) : array<mixed,\app\framework\Component\Console\Command\Command>
Gets the commands (registered in the given namespace if provided).
The array keys are the full names and the values the command instances.
| string | $namespace | A namespace name |
An array of Command instances
extractNamespace(string $name, string $limit = null) : string
Returns the namespace part of the command name.
This method is not part of public API and should not be used directly.
| string | $name | The full name of the command |
| string | $limit | The maximum number of parts of the namespace |
The namespace of the command
findNamespace(string $namespace) : string
Finds a registered namespace by a name or an abbreviation.
| string | $namespace | A namespace or abbreviation to search for |
When namespace is incorrect or ambiguous
A registered namespace
getDefinition() : \app\framework\Component\Console\Input\InputDefinition
Gets the InputDefinition related to this Application.
The InputDefinition instance
setDefinition(\app\framework\Component\Console\Input\InputDefinition $definition)
| \app\framework\Component\Console\Input\InputDefinition | $definition |
doRenderException(\Exception $e, \app\framework\Component\Console\Output\OutputInterface $output)
I have no clue.
| \Exception | $e | |
| \app\framework\Component\Console\Output\OutputInterface | $output |
configureIO(\app\framework\Component\Console\Input\InputInterface $input, \app\framework\Component\Console\Output\OutputInterface $output)
Configures the input and output instances based on the user arguments and options.
| \app\framework\Component\Console\Input\InputInterface | $input | |
| \app\framework\Component\Console\Output\OutputInterface | $output |
getDefaultInputDefinition() : \app\framework\Component\Console\Input\InputDefinition
Gets the default input definition.
An InputDefinition instance
getCommandName(\app\framework\Component\Console\Input\InputInterface $input) : null|string
Get name of command from Input.
| \app\framework\Component\Console\Input\InputInterface | $input |
getDefaultCommands() : array<mixed,\app\framework\Component\Console\Command\Command>
To get an array of default commands.
findAlternatives(string $name, \app\framework\Component\Console\iterable $collection) : array<mixed,string>
Finds alternative of $name among $collection, if nothing is found in $collection, try in $abbrevs.
| string | $name | The string |
| \app\framework\Component\Console\iterable | $collection | The collection |
A sorted array of similar string