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();

Direct known subclasses

Contrib\Bundle\CoverallsBundle\Console\Application

Namespace: Symfony\Component\Console
Author: Fabien Potencier <fabien@symfony.com>
Api
Located at console/Symfony/Component/Console/Application.php

Methods summary
`public`	# `__construct( string $name = 'UNKNOWN', string $version = 'UNKNOWN' )` Constructor. Constructor. Parameters `$name` `string` $name The name of the application `$version` `string` $version The version of the application Api
`public integer`	# `run( Symfony\Component\Console\Input\InputInterface $input = null, Symfony\Component\Console\Output\OutputInterface $output = null )` Runs the current application. Runs the current application. Parameters `$input` `Symfony\Component\Console\Input\InputInterface` $input An Input instance `$output` `Symfony\Component\Console\Output\OutputInterface` $output An Output instance Returns `integer` 0 if everything went fine, or an error code Throws `Exception` When doRun returns Exception Api
`public integer`	# `doRun( Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output )` Runs the current application. Runs the current application. Parameters `$input` `Symfony\Component\Console\Input\InputInterface` $input An Input instance `$output` `Symfony\Component\Console\Output\OutputInterface` $output An Output instance Returns `integer` 0 if everything went fine, or an error code
`public`	# `setHelperSet( Symfony\Component\Console\Helper\HelperSet $helperSet )` Set a helper set to be used with the command. Set a helper set to be used with the command. Parameters `$helperSet` `Symfony\Component\Console\Helper\HelperSet` $helperSet The helper set Api
`public Symfony\Component\Console\Helper\HelperSet`	# `getHelperSet( )` Get the helper set associated with the command. Get the helper set associated with the command. Returns `Symfony\Component\Console\Helper\HelperSet` The HelperSet instance associated with this command Api
`public`	# `setDefinition( Symfony\Component\Console\Input\InputDefinition $definition )` Set an input definition set to be used with this application Set an input definition set to be used with this application Parameters `$definition` `Symfony\Component\Console\Input\InputDefinition` $definition The input definition Api
`public Symfony\Component\Console\Input\InputDefinition`	# `getDefinition( )` Gets the InputDefinition related to this Application. Gets the InputDefinition related to this Application. Returns `Symfony\Component\Console\Input\InputDefinition` The InputDefinition instance
`public string`	# `getHelp( )` Gets the help message. Gets the help message. Returns `string` A help message.
`public`	# `setCatchExceptions( Boolean $boolean )` Sets whether to catch exceptions or not during commands execution. Sets whether to catch exceptions or not during commands execution. Parameters `$boolean` `Boolean` $boolean Whether to catch exceptions or not during commands execution Api
`public`	# `setAutoExit( Boolean $boolean )` Sets whether to automatically exit after a command execution or not. Sets whether to automatically exit after a command execution or not. Parameters `$boolean` `Boolean` $boolean Whether to automatically exit after a command execution or not Api
`public string`	# `getName( )` Gets the name of the application. Gets the name of the application. Returns `string` The application name Api
`public`	# `setName( string $name )` Sets the application name. Sets the application name. Parameters `$name` `string` $name The application name Api
`public string`	# `getVersion( )` Gets the application version. Gets the application version. Returns `string` The application version Api
`public`	# `setVersion( string $version )` Sets the application version. Sets the application version. Parameters `$version` `string` $version The application version Api
`public string`	# `getLongVersion( )` Returns the long version of the application. Returns the long version of the application. Returns `string` The long application version Api
`public Symfony\Component\Console\Command\Command`	# `register( string $name )` Registers a new command. Registers a new command. Parameters `$name` `string` $name The command name Returns `Symfony\Component\Console\Command\Command` The newly created command Api
`public`	# `addCommands( array $commands )` Adds an array of command objects. Adds an array of command objects. Parameters `$commands` `Symfony\Component\Console\Command\Command[]` $commands An array of commands Api
`public Symfony\Component\Console\Command\Command`	# `add( Symfony\Component\Console\Command\Command $command )` Adds a command object. Adds a command object. If a command with the same name already exists, it will be overridden. Parameters `$command` `Symfony\Component\Console\Command\Command` $command A Command object Returns `Symfony\Component\Console\Command\Command` The registered command Api
`public Symfony\Component\Console\Command\Command`	# `get( string $name )` Returns a registered command by name or alias. Returns a registered command by name or alias. Parameters `$name` `string` $name The command name or alias Returns `Symfony\Component\Console\Command\Command` A Command object Throws `InvalidArgumentException` When command name given does not exist Api
`public Boolean`	# `has( string $name )` Returns true if the command exists, false otherwise. Returns true if the command exists, false otherwise. Parameters `$name` `string` $name The command name or alias Returns `Boolean` true if the command exists, false otherwise Api
`public array`	# `getNamespaces( )` Returns an array of all unique namespaces used by currently registered commands. Returns an array of all unique namespaces used by currently registered commands. It does not returns the global namespace which always exists. Returns `array` An array of namespaces
`public string`	# `findNamespace( string $namespace )` Finds a registered namespace by a name or an abbreviation. Finds a registered namespace by a name or an abbreviation. Parameters `$namespace` `string` $namespace A namespace or abbreviation to search for Returns `string` A registered namespace Throws `InvalidArgumentException` When namespace is incorrect or ambiguous
`public Symfony\Component\Console\Command\Command`	# `find( string $name )` Finds a command by name or alias. 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 `$name` `string` $name A command name or a command alias Returns `Symfony\Component\Console\Command\Command` A Command instance Throws `InvalidArgumentException` When command name is incorrect or ambiguous Api
`public Symfony\Component\Console\Command\Command[]`	# `all( string $namespace = null )` Gets the commands (registered in the given namespace if provided). Gets the commands (registered in the given namespace if provided). The array keys are the full names and the values the command instances. Parameters `$namespace` `string` $namespace A namespace name Returns `Symfony\Component\Console\Command\Command[]` An array of Command instances Api
`public static array`	# `getAbbreviations( array $names )` Returns an array of possible abbreviations given a set of names. Returns an array of possible abbreviations given a set of names. Parameters `$names` `array` $names An array of names Returns `array` An array of abbreviations
`public string`	# `asText( string $namespace = null, boolean $raw = false )` Returns a text representation of the Application. Returns a text representation of the Application. Parameters `$namespace` `string` $namespace An optional namespace name `$raw` `boolean` $raw Whether to return raw command list Returns `string` A string representing the Application
`public string\|DOMDocument`	# `asXml( string $namespace = null, Boolean $asDom = false )` Returns an XML representation of the Application. Returns an XML representation of the Application. Parameters `$namespace` `string` $namespace An optional namespace name `$asDom` `Boolean` $asDom Whether to return a DOM or an XML string Returns `string\|DOMDocument` An XML string representing the Application
`public`	# `renderException( Exception $e, Symfony\Component\Console\Output\OutputInterface $output )` Renders a caught exception. Renders a caught exception. Parameters `$e` `Exception` $e An exception instance `$output` `Symfony\Component\Console\Output\OutputInterface` $output An OutputInterface instance
`protected integer\|null`	# `getTerminalWidth( )` Tries to figure out the terminal width in which this application runs Tries to figure out the terminal width in which this application runs Returns `integer\|null`
`protected integer\|null`	# `getTerminalHeight( )` Tries to figure out the terminal height in which this application runs Tries to figure out the terminal height in which this application runs Returns `integer\|null`
`public array`	# `getTerminalDimensions( )` Tries to figure out the terminal dimensions based on the current environment Tries to figure out the terminal dimensions based on the current environment Returns `array` Array containing width and height
`protected string`	# `getCommandName( Symfony\Component\Console\Input\InputInterface $input )` Gets the name of the command based on input. Gets the name of the command based on input. Parameters `$input` `Symfony\Component\Console\Input\InputInterface` $input The input interface Returns `string` The command name
`protected Symfony\Component\Console\Input\InputDefinition`	# `getDefaultInputDefinition( )` Gets the default input definition. Gets the default input definition. Returns `Symfony\Component\Console\Input\InputDefinition` An InputDefinition instance
`protected Symfony\Component\Console\Command\Command[]`	# `getDefaultCommands( )` Gets the default commands that should always be available. Gets the default commands that should always be available. Returns `Symfony\Component\Console\Command\Command[]` An array of default Command instances
`protected Symfony\Component\Console\Helper\HelperSet`	# `getDefaultHelperSet( )` Gets the default helper set with the helpers that should always be available. Gets the default helper set with the helpers that should always be available. Returns `Symfony\Component\Console\Helper\HelperSet` A HelperSet instance

Namespaces

Classes

Class Application

Direct known subclasses

Parameters

Api

Parameters

Returns

Throws

Api

Parameters

Returns

Parameters

Api

Returns

Api

Parameters

Api

Returns

Returns

Parameters

Api

Parameters

Api

Returns

Api

Parameters

Api

Returns

Api

Parameters

Api

Returns

Api

Parameters

Returns

Api

Parameters

Api

Parameters

Returns

Api

Parameters

Returns

Throws

Api

Parameters

Returns

Api

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Api

Parameters

Returns

Api

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns