Class

Symfony\Bundle\FrameworkBundle\Console\Application

class Application extends Application

Application.

Methods

__construct(KernelInterface $kernel)

Constructor.

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

Runs the current application.

from Application
integer doRun(InputInterface $input, OutputInterface $output)

Runs the current application.

setHelperSet(HelperSet $helperSet)

Set a helper set to be used with the command.

from Application
HelperSet getHelperSet()

Get the helper set associated with the command.

from Application
InputDefinition getDefinition()

Gets the InputDefinition related to this Application.

from Application
string getHelp()

Gets the help message.

from Application
setCatchExceptions(Boolean $boolean)

Sets whether to catch exceptions or not during commands execution.

from Application
setAutoExit(Boolean $boolean)

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

from Application
string getName()

Gets the name of the application.

from Application
setName(string $name)

Sets the application name.

from Application
string getVersion()

Gets the application version.

from Application
setVersion(string $version)

Sets the application version.

from Application
string getLongVersion()

Returns the long version of the application.

from Application
Command register(string $name)

Registers a new command.

from Application
addCommands(array $commands)

Adds an array of command objects.

from Application
Command add(Command $command)

Adds a command object.

from Application
Command get(string $name)

Returns a registered command by name or alias.

from Application
Boolean has(string $name)

Returns true if the command exists, false otherwise.

from Application
array getNamespaces()

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

from Application
string findNamespace(string $namespace)

Finds a registered namespace by a name or an abbreviation.

from Application
Command find(string $name)

Finds a command by name or alias.

from Application
array all(string $namespace = null)

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

from Application
static array getAbbreviations(array $names)

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

from Application
string asText(string $namespace = null, boolean $raw = false)

Returns a text representation of the Application.

from Application
string|DOMDocument asXml(string $namespace = null, Boolean $asDom = false)

Returns an XML representation of the Application.

from Application
renderException(Exception $e, OutputInterface $output)

Renders a caught exception.

from Application
array getTerminalDimensions()

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

from Application
KernelInterface getKernel()

Gets the Kernel associated with this Console.

Details

at line 36
public __construct(KernelInterface $kernel)

Constructor.

Parameters

KernelInterface $kernel A KernelInterface instance

in Application at line 94
public integer run(InputInterface $input = null, OutputInterface $output = null)

Runs the current application.

Parameters

InputInterface $input An Input instance
OutputInterface $output An Output instance

Return Value

integer 0 if everything went fine, or an error code

Exceptions

Exception When doRun returns Exception

at line 66
public integer doRun(InputInterface $input, OutputInterface $output)

Runs the current application.

Parameters

InputInterface $input An Input instance
OutputInterface $output An Output instance

Return Value

integer 0 if everything went fine, or an error code

in Application at line 212
public setHelperSet(HelperSet $helperSet)

Set a helper set to be used with the command.

Parameters

HelperSet $helperSet The helper set

in Application at line 224
public HelperSet getHelperSet()

Get the helper set associated with the command.

Return Value

HelperSet The HelperSet instance associated with this command

in Application at line 234
public InputDefinition getDefinition()

Gets the InputDefinition related to this Application.

Return Value

InputDefinition The InputDefinition instance

in Application at line 244
public string getHelp()

Gets the help message.

Return Value

string A help message.

in Application at line 272
public setCatchExceptions(Boolean $boolean)

Sets whether to catch exceptions or not during commands execution.

Parameters

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

in Application at line 284
public setAutoExit(Boolean $boolean)

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

Parameters

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

in Application at line 296
public string getName()

Gets the name of the application.

Return Value

string The application name

in Application at line 308
public setName(string $name)

Sets the application name.

Parameters

string $name The application name

in Application at line 320
public string getVersion()

Gets the application version.

Return Value

string The application version

in Application at line 332
public setVersion(string $version)

Sets the application version.

Parameters

string $version The application version

in Application at line 344
public string getLongVersion()

Returns the long version of the application.

Return Value

string The long application version

in Application at line 362
public Command register(string $name)

Registers a new command.

Parameters

string $name The command name

Return Value

Command The newly created command

in Application at line 374
public addCommands(array $commands)

Adds an array of command objects.

Parameters

array $commands An array of commands

in Application at line 392
public Command add(Command $command)

Adds a command object.

If a command with the same name already exists, it will be overridden.

Parameters

Command $command A Command object

Return Value

Command The registered command

in Application at line 422
public 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

InvalidArgumentException When command name given does not exist

in Application at line 451
public Boolean has(string $name)

Returns true if the command exists, false otherwise.

Parameters

string $name The command name or alias

Return Value

Boolean true if the command exists, false otherwise

in Application at line 463
public array getNamespaces()

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

It does not returns the global namespace which always exists.

Return Value

array An array of namespaces

in Application at line 486
public 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

InvalidArgumentException When namespace is incorrect or ambiguous

in Application at line 550
public 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

InvalidArgumentException When command name is incorrect or ambiguous

in Application at line 633
public array 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

array An array of Command instances

in Application at line 656
static public 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

in Application at line 677
public string asText(string $namespace = null, boolean $raw = false)

Returns a text representation of the Application.

Parameters

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

Return Value

string A string representing the Application

in Application at line 727
public string|DOMDocument asXml(string $namespace = null, Boolean $asDom = false)

Returns an XML representation of the Application.

Parameters

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

Return Value

string|DOMDocument An XML string representing the Application

in Application at line 779
public renderException(Exception $e, OutputInterface $output)

Renders a caught exception.

Parameters

Exception $e An exception instance
OutputInterface $output An OutputInterface instance

in Application at line 884
public array getTerminalDimensions()

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

Return Value

array Array containing width and height

at line 53
public KernelInterface getKernel()

Gets the Kernel associated with this Console.

Return Value

KernelInterface A KernelInterface instance