Class Symfony\Component\Console\Application

`implements`	`ResetInterface`


					
	public

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

#


					
	public

setDispatcher(EventDispatcherInterface $dispatcher): void

#


					
	public

setCommandLoader(CommandLoaderInterface $commandLoader): void

#


					
	public

getSignalRegistry(): SignalRegistry

#


					
	public

setSignalsToDispatchEvent(int ...$signalsToDispatchEvent): void

#


					
	public

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

Runs the current application.

Returns

0 if everything went fine, or an error code

Throws

Exception

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

#


					
	public

doRun(InputInterface $input, OutputInterface $output): int

Runs the current application.

Returns

0 if everything went fine, or an error code

#


					
	public

reset(): void

Implements

Symfony\Contracts\Service\ResetInterface::reset()

#


					
	public

setHelperSet(HelperSet $helperSet): void

#


					
	public

getHelperSet(): HelperSet

Get the helper set associated with the command.

#


					
	public

setDefinition(InputDefinition $definition): void

#


					
	public

getDefinition(): InputDefinition

Gets the InputDefinition related to this Application.

#


					
	public

complete(CompletionInput $input, CompletionSuggestions $suggestions): void

Adds suggestions to $suggestions for the current completion input (e.g. option or argument).

#


					
	public

getHelp(): string

Gets the help message.

#


					
	public

areExceptionsCaught(): bool

Gets whether to catch exceptions or not during commands execution.

#


					
	public

setCatchExceptions(bool $boolean): void

Sets whether to catch exceptions or not during commands execution.

#


					
	public

isAutoExitEnabled(): bool

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

#


					
	public

setAutoExit(bool $boolean): void

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

#


					
	public

getName(): string

Gets the name of the application.

#


					
	public

setName(string $name): void

Sets the application name.

#


					
	public

getVersion(): string

Gets the application version.

#


					
	public

setVersion(string $version): void

Sets the application version.

#


					
	public

getLongVersion(): string

Returns the long version of the application.

#


					
	public

register(string $name): Command

Registers a new command.

#


					
	public

addCommands(Command[] $commands): void

Adds an array of command objects.

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

Parameters

$commands

An array of commands

#


					
	public

add(Command $command): Command|null

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.

#


					
	public

get(string $name): Command

Returns a registered command by name or alias.

Throws

Symfony\Component\Console\Exception\CommandNotFoundException

When given command name does not exist

#


					
	public

has(string $name): bool

Returns true if the command exists, false otherwise.

#


					
	public

getNamespaces(): string[]

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

It does not return the global namespace which always exists.

#


					
	public

findNamespace(string $namespace): string

Finds a registered namespace by a name or an abbreviation.

Throws

Symfony\Component\Console\Exception\NamespaceNotFoundException

When namespace is incorrect or ambiguous

#


					
	public

find(string $name): Command

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.

Throws

Symfony\Component\Console\Exception\CommandNotFoundException

When command name is incorrect or ambiguous

#


					
	public

all(string $namespace = null): Command[]

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

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

#


					
	public
					static

getAbbreviations(array $names): string[][]

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

#


					
	public

renderThrowable(Throwable $e, OutputInterface $output): void

#


					
	protected

doRenderThrowable(Throwable $e, OutputInterface $output): void

#


					
	protected

configureIO(InputInterface $input, OutputInterface $output): void

Configures the input and output instances based on the user arguments and options.

#


					
	protected

doRunCommand(Command $command, InputInterface $input, OutputInterface $output): int

Runs the current command.

If an event dispatcher has been attached to the application, events are also dispatched during the life-cycle of the command.

Returns

0 if everything went fine, or an error code

#


					
	protected

getCommandName(InputInterface $input): ?string

Gets the name of the command based on input.

#


					
	protected

getDefaultInputDefinition(): InputDefinition

Gets the default input definition.

#


					
	protected

getDefaultCommands(): Command[]

Gets the default commands that should always be available.

#


					
	protected

getDefaultHelperSet(): HelperSet

Gets the default helper set with the helpers that should always be available.

#


					
	private

getAbbreviationSuggestions(array $abbrevs): string

Returns abbreviated suggestions in string format.

#


					
	public

extractNamespace(string $name, int $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.

#


					
	private

findAlternatives(string $name, iterable $collection): string[]

Finds alternative of $name among $collection, if nothing is found in $collection, try in $abbrevs.

#


					
	public

setDefaultCommand(string $commandName, bool $isSingleCommand = false): $this

Sets the default Command name.

#


					
	private

splitStringByWidth(string $string, int $width): array

#


					
	private

extractAllNamespaces(string $name): string[]

Returns all namespaces of the command name.

#


					
	private

init(): void

#

Properties
`private`	`array`	`$commands = []`	#
`private`	`bool`	`$wantHelps = false`	#
`private`	`?Command`	`$runningCommand = null`	#
`private`	`string`	`$name`	#
`private`	`string`	`$version`	#
`private`	`?CommandLoaderInterface`	`$commandLoader = null`	#
`private`	`bool`	`$catchExceptions = true`	#
`private`	`bool`	`$autoExit = true`	#
`private`	`InputDefinition`	`$definition`	#
`private`	`HelperSet`	`$helperSet`	#
`private`	`?EventDispatcherInterface`	`$dispatcher = null`	#
`private`	`Terminal`	`$terminal`	#
`private`	`string`	`$defaultCommand`	#
`private`	`bool`	`$singleCommand = false`	#
`private`	`bool`	`$initialized = false`	#
`private`	`?SignalRegistry`	`$signalRegistry = null`	#
`private`	`array`	`$signalsToDispatchEvent = []`	#

Namespaces

Classes

Class Symfony\Component\Console\Application

Returns

Throws

Returns

Implements

Parameters

Throws

Throws

Throws

Returns