class Application

An Application is the container for a collection of commands.

It is the main entry point of a Console application.

This class is optimized for a standard CLI environment.

Usage:

$app = new Application('myapp', '1.0 (stable)');
$app->add(new SimpleCommand());
$app->run();

Methods

__construct(string $name = 'UNKNOWN', string $version = 'UNKNOWN')

No description

setDispatcher(EventDispatcherInterface $dispatcher)

No description

int
run(InputInterface $input = null, OutputInterface $output = null)

Runs the current application.

int
doRun(InputInterface $input, OutputInterface $output)

Runs the current application.

setHelperSet(HelperSet $helperSet)

No description

getHelperSet()

Get the helper set associated with the command.

setDefinition(InputDefinition $definition)

No description

getDefinition()

Gets the InputDefinition related to this Application.

string
getHelp()

Gets the help message.

setCatchExceptions(bool $boolean)

Sets whether to catch exceptions or not during commands execution.

setAutoExit(bool $boolean)

Sets whether to automatically exit after a command execution or not.

string
getName()

Gets the name of the application.

setName(string $name)

Sets the application name.

string
getVersion()

Gets the application version.

setVersion(string $version)

Sets the application version.

string
getLongVersion()

Returns the long version of the application.

register(string $name)

Registers a new command.

addCommands(array $commands)

Adds an array of command objects.

Command|null
add(Command $command)

Adds a command object.

get(string $name)

Returns a registered command by name or alias.

bool
has(string $name)

Returns true if the command exists, false otherwise.

string[]
getNamespaces()

Returns an array of all unique namespaces used by currently registered commands.

string
findNamespace(string $namespace)

Finds a registered namespace by a name or an abbreviation.

find(string $name)

Finds a command by name or alias.

all(string $namespace = null)

Gets the commands (registered in the given namespace if provided).

static array
getAbbreviations(array $names)

Returns an array of possible abbreviations given a set of names.

string
asText(string $namespace = null, bool $raw = false) deprecated

Returns a text representation of the Application.

string|DOMDocument
asXml(string $namespace = null, bool $asDom = false) deprecated

Returns an XML representation of the Application.

renderException($e, $output)

Renders a caught exception.

array
getTerminalDimensions()

Tries to figure out the terminal dimensions based on the current environment.

$this
setTerminalDimensions(int $width, int $height)

Sets terminal dimensions.

string
extractNamespace(string $name, string $limit = null)

Returns the namespace part of the command name.

setDefaultCommand(string $commandName)

Sets the default Command name.

Details

at line line 84
__construct(string $name = 'UNKNOWN', string $version = 'UNKNOWN')

Parameters

string $name The name of the application
string $version The version of the application

at line line 91
setDispatcher(EventDispatcherInterface $dispatcher)

Parameters

EventDispatcherInterface $dispatcher

at line line 103
int run(InputInterface $input = null, OutputInterface $output = null)

Runs the current application.

Parameters

InputInterface $input
OutputInterface $output

Return Value

int 0 if everything went fine, or an error code

Exceptions

Exception When running fails. Bypass this when {@link setCatchExceptions()}.

at line line 159
int doRun(InputInterface $input, OutputInterface $output)

Runs the current application.

Parameters

InputInterface $input
OutputInterface $output

Return Value

int 0 if everything went fine, or an error code

at line line 199
setHelperSet(HelperSet $helperSet)

Parameters

HelperSet $helperSet

at line line 209
HelperSet getHelperSet()

Get the helper set associated with the command.

Return Value

HelperSet The HelperSet instance associated with this command

at line line 218
setDefinition(InputDefinition $definition)

Parameters

InputDefinition $definition

at line line 228
InputDefinition getDefinition()

Gets the InputDefinition related to this Application.

Return Value

InputDefinition The InputDefinition instance

at line line 242
string getHelp()

Gets the help message.

Return Value

string A help message

at line line 252
setCatchExceptions(bool $boolean)

Sets whether to catch exceptions or not during commands execution.

Parameters

bool $boolean Whether to catch exceptions or not during commands execution

at line line 262
setAutoExit(bool $boolean)

Sets whether to automatically exit after a command execution or not.

Parameters

bool $boolean Whether to automatically exit after a command execution or not

at line line 272
string getName()

Gets the name of the application.

Return Value

string The application name

at line line 282
setName(string $name)

Sets the application name.

Parameters

string $name The application name

at line line 292
string getVersion()

Gets the application version.

Return Value

string The application version

at line line 302
setVersion(string $version)

Sets the application version.

Parameters

string $version The application version

at line line 312
string getLongVersion()

Returns the long version of the application.

Return Value

string The long application version

at line line 332
Command register(string $name)

Registers a new command.

Parameters

string $name The command name

Return Value

Command The newly created command

at line line 344
addCommands(array $commands)

Adds an array of command objects.

If a Command is not enabled it will not be added.

Parameters

array $commands An array of commands

at line line 359
Command|null add(Command $command)

Adds a command object.

If a command with the same name already exists, it will be overridden. If the command is not enabled it will not be added.

Parameters

Command $command

Return Value

Command|null The registered command if enabled or null

at line line 393
Command get(string $name)

Returns a registered command by name or alias.

Parameters

string $name The command name or alias

Return Value

Command A Command object

Exceptions

CommandNotFoundException When given command name does not exist

at line line 422
bool has(string $name)

Returns true if the command exists, false otherwise.

Parameters

string $name The command name or alias

Return Value

bool true if the command exists, false otherwise

at line line 436
string[] getNamespaces()

Returns an array of all unique namespaces used by currently registered commands.

It does not return the global namespace which always exists.

Return Value

string[] An array of namespaces

at line line 459
string findNamespace(string $namespace)

Finds a registered namespace by a name or an abbreviation.

Parameters

string $namespace A namespace or abbreviation to search for

Return Value

string A registered namespace

Exceptions

CommandNotFoundException When namespace is incorrect or ambiguous

at line line 501
Command find(string $name)

Finds a command by name or alias.

Contrary to get, this command tries to find the best match if you give it an abbreviation of a name or alias.

Parameters

string $name A command name or a command alias

Return Value

Command A Command instance

Exceptions

CommandNotFoundException When command name is incorrect or ambiguous

at line line 559
Command[] all(string $namespace = null)

Gets the commands (registered in the given namespace if provided).

The array keys are the full names and the values the command instances.

Parameters

string $namespace A namespace name

Return Value

Command[] An array of Command instances

at line line 584
static array getAbbreviations(array $names)

Returns an array of possible abbreviations given a set of names.

Parameters

array $names An array of names

Return Value

array An array of abbreviations

at line line 607
string asText(string $namespace = null, bool $raw = false) deprecated

deprecated since version 2.3, to be removed in 3.0.

Returns a text representation of the Application.

Parameters

string $namespace An optional namespace name
bool $raw Whether to return raw command list

Return Value

string A string representing the Application

at line line 628
string|DOMDocument asXml(string $namespace = null, bool $asDom = false) deprecated

deprecated since version 2.3, to be removed in 3.0.

Returns an XML representation of the Application.

Parameters

string $namespace An optional namespace name
bool $asDom Whether to return a DOM or an XML string

Return Value

string|DOMDocument An XML string representing the Application

at line line 647
renderException($e, $output)

Renders a caught exception.

Parameters

$e
$output

at line line 744
array getTerminalDimensions()

Tries to figure out the terminal dimensions based on the current environment.

Return Value

array Array containing width and height

at line line 785
$this setTerminalDimensions(int $width, int $height)

Sets terminal dimensions.

Can be useful to force terminal dimensions for functional tests.

Parameters

int $width The width
int $height The height

Return Value

$this

at line line 1017
string extractNamespace(string $name, string $limit = null)

Returns the namespace part of the command name.

This method is not part of public API and should not be used directly.

Parameters

string $name The full name of the command
string $limit The maximum number of parts of the namespace

Return Value

string The namespace of the command

at line line 1081
setDefaultCommand(string $commandName)

Sets the default Command name.

Parameters

string $commandName The Command name