Référence de la classe Application

Graphe d'héritage de Application:

Fonctions membres publiques
	__construct (string $name='UNKNOWN', string $version='UNKNOWN')
	setDispatcher (EventDispatcherInterface $dispatcher)
	setCommandLoader (CommandLoaderInterface $commandLoader)
	getSignalRegistry ()
	setSignalsToDispatchEvent (int ... $signalsToDispatchEvent)
	run (InputInterface $input=null, OutputInterface $output=null)
	doRun (InputInterface $input, OutputInterface $output)
	reset ()
	setHelperSet (HelperSet $helperSet)
	getHelperSet ()
	setDefinition (InputDefinition $definition)
	getDefinition ()
	complete (CompletionInput $input, CompletionSuggestions $suggestions)
	getHelp ()
	areExceptionsCaught ()
	setCatchExceptions (bool $boolean)
	isAutoExitEnabled ()
	setAutoExit (bool $boolean)
	getName ()
	setName (string $name)
	getVersion ()
	setVersion (string $version)
	getLongVersion ()
	register (string $name)
	addCommands (array $commands)
	add (Command $command)
	get (string $name)
	has (string $name)
	getNamespaces ()
	findNamespace (string $namespace)
	find (string $name)
	all (string $namespace=null)
	renderThrowable (\Throwable $e, OutputInterface $output)
	extractNamespace (string $name, int $limit=null)
	setDefaultCommand (string $commandName, bool $isSingleCommand=false)
	isSingleCommand ()

Fonctions membres publiques statiques
static	getAbbreviations (array $names)

Fonctions membres protégées
	doRenderThrowable (\Throwable $e, OutputInterface $output)
	configureIO (InputInterface $input, OutputInterface $output)
	doRunCommand (Command $command, InputInterface $input, OutputInterface $output)
	getCommandName (InputInterface $input)
	getDefaultInputDefinition ()
	getDefaultCommands ()
	getDefaultHelperSet ()

Fonctions membres privées
	getAbbreviationSuggestions (array $abbrevs)
	findAlternatives (string $name, iterable $collection)
	splitStringByWidth (string $string, int $width)
	extractAllNamespaces (string $name)
	init ()

Attributs privés
	$commands = []
	$wantHelps = false
	$runningCommand
	$name
	$version
	$commandLoader
	$catchExceptions = true
	$autoExit = true
	$definition
	$helperSet
	$dispatcher
	$terminal
	$defaultCommand
	$singleCommand = false
	$initialized
	$signalRegistry
	$signalsToDispatchEvent = []

Description détaillée

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

Auteur

Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Documentation des constructeurs et destructeur

__construct()

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

Références Application\$name, Application\$version, SignalRegistry\isSupported(), et name.

Documentation des fonctions membres

add()

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.

Renvoie

Command|null

Références $this, Command\getAliases(), Command\getDefinition(), Command\getName(), Application\init(), Command\isEnabled(), null, et Command\setApplication().

Référencé par Application\addCommands(), Application\has(), Application\init(), et Application\register().

addCommands()

addCommands

(

array

$commands

)

Adds an array of command objects.

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

Paramètres

Command[]

$commands An array of commands

Références Application\$commands, et Application\add().

all()

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.

Renvoie

Command[]

Références Application\$commands, Application\$name, $namespace, Application\extractNamespace(), Application\has(), Application\init(), et null.

Référencé par Application\complete(), et Application\getNamespaces().

areExceptionsCaught()

areExceptionsCaught

(

)

Gets whether to catch exceptions or not during commands execution.

Renvoie

bool

Références Application\$catchExceptions.

complete()

complete	(	CompletionInput	$input,
		CompletionSuggestions	$suggestions
	)

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

Références $input, Application\all(), CompletionInput\getCompletionType(), Application\getDefinition(), Command\getName(), Command\isHidden(), null, CompletionSuggestions\suggestOptions(), CompletionSuggestions\suggestValues(), CompletionInput\TYPE_ARGUMENT_VALUE, et CompletionInput\TYPE_OPTION_NAME.

configureIO()

configureIO ( InputInterface  $input, OutputInterface  $output  )

protected

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

Références $input, $output, elseif, OutputInterface\VERBOSITY_DEBUG, OutputInterface\VERBOSITY_QUIET, OutputInterface\VERBOSITY_VERBOSE, et OutputInterface\VERBOSITY_VERY_VERBOSE.

Référencé par Application\run().

doRenderThrowable()

doRenderThrowable ( \Throwable  $e, OutputInterface  $output  )

protected

Références $class, $count, $function, $i, $message, $messages, $output, $title, $type, $width, OutputFormatter\escape(), Application\splitStringByWidth(), OutputInterface\VERBOSITY_QUIET, et Helper\width().

Référencé par Application\renderThrowable().

doRun()

doRun	(	InputInterface	$input,
		OutputInterface	$output
	)

Runs the current application.

Renvoie

int 0 if everything went fine, or an error code

Références Application\$defaultCommand, Application\$definition, $input, Application\$name, $output, $style, InputInterface\bind(), Application\doRunCommand(), ConsoleEvents\ERROR, Application\find(), Application\getCommandName(), Application\getDefinition(), Application\getLongVersion(), null, et InputArgument\OPTIONAL.

Référencé par Application\run().

doRunCommand()

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

protected

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.

Renvoie

int 0 if everything went fine, or an error code

Références $helper, $input, $output, ConsoleEvents\COMMAND, ConsoleEvents\ERROR, Command\getDefinition(), Command\getHelperSet(), Terminal\hasSttyAvailable(), Command\mergeApplicationDefinition(), null, ConsoleCommandEvent\RETURN_CODE_DISABLED, Command\run(), ConsoleEvents\SIGNAL, et ConsoleEvents\TERMINATE.

Référencé par Application\doRun().

extractAllNamespaces()

extractAllNamespaces ( string  $name )

private

Returns all namespaces of the command name.

Renvoie

string[]

Références Application\$name, et $parts.

Référencé par Application\getNamespaces().

extractNamespace()

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

Returns the namespace part of the command name.

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

Renvoie

string

Références $limit, Application\$name, $parts, et null.

Référencé par Application\all().

find()

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.

Renvoie

Command

Exceptions

CommandNotFoundException

When command name is incorrect or ambiguous

Références Application\$commands, $message, Application\$name, Application\findAlternatives(), Application\findNamespace(), Application\getAbbreviationSuggestions(), Application\has(), Application\init(), Application\reset(), Helper\substr(), et Helper\width().

Référencé par Application\doRun(), et Application\setDefaultCommand().

findAlternatives()

findAlternatives ( string  $name, iterable  $collection  )

private

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

Renvoie

string[]

Références $i, $item, Application\$name, $parts, et elseif.

Référencé par Application\find(), et Application\findNamespace().

findNamespace()

findNamespace

(

string

$namespace

)

Finds a registered namespace by a name or an abbreviation.

Renvoie

string

Exceptions

NamespaceNotFoundException

When namespace is incorrect or ambiguous

Références $message, $namespace, Application\findAlternatives(), Application\getAbbreviationSuggestions(), Application\getNamespaces(), et Application\reset().

Référencé par Application\find().

get()

get

(

string

$name

)

Returns a registered command by name or alias.

Renvoie

Command

Exceptions

CommandNotFoundException

When given command name does not exist

Références Application\$name, Application\has(), et Application\init().

getAbbreviations()

static getAbbreviations ( array  $names )

static

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

Renvoie

string[][]

Références Application\$name, et $names.

getAbbreviationSuggestions()

getAbbreviationSuggestions ( array  $abbrevs )

private

Returns abbreviated suggestions in string format.

Référencé par Application\find(), et Application\findNamespace().

getCommandName()

getCommandName ( InputInterface  $input )

protected

Gets the name of the command based on input.

Renvoie

string|null

Références $input.

Référencé par Application\doRun().

getDefaultCommands()

getDefaultCommands ( )

protected

Gets the default commands that should always be available.

Renvoie

Command[]

Référencé par Application\init().

getDefaultHelperSet()

getDefaultHelperSet ( )

protected

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

Renvoie

HelperSet

Référencé par Application\getHelperSet().

getDefaultInputDefinition()

getDefaultInputDefinition ( )

protected

Gets the default input definition.

Renvoie

InputDefinition

Références null, InputArgument\REQUIRED, InputOption\VALUE_NEGATABLE, et InputOption\VALUE_NONE.

Référencé par Application\getDefinition().

getDefinition()

getDefinition

(

)

Gets the InputDefinition related to this Application.

Renvoie

InputDefinition

Références Application\$definition, et Application\getDefaultInputDefinition().

Référencé par Application\complete(), TextDescriptor\describeApplication(), et Application\doRun().

getHelp()

getHelp

(

)

Gets the help message.

Renvoie

string

Références Application\getLongVersion().

Référencé par TextDescriptor\describeApplication().

getHelperSet()

getHelperSet

(

)

Get the helper set associated with the command.

Renvoie

HelperSet

Références Application\$helperSet, et Application\getDefaultHelperSet().

getLongVersion()

getLongVersion

(

)

Returns the long version of the application.

Renvoie

string

Références Application\getName(), et Application\getVersion().

Référencé par Application\doRun(), et Application\getHelp().

getName()

getName

(

)

Gets the name of the application.

Renvoie

string

Références Application\$name.

Référencé par JsonDescriptor\describeApplication(), XmlDescriptor\getApplicationDocument(), MarkdownDescriptor\getApplicationTitle(), Application\getLongVersion(), et Application\renderThrowable().

getNamespaces()

getNamespaces

(

)

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

It does not return the global namespace which always exists.

Renvoie

string[]

Références Application\all(), et Application\extractAllNamespaces().

Référencé par Application\findNamespace().

getSignalRegistry()

getSignalRegistry

(

)

Références Application\$signalRegistry.

getVersion()

getVersion

(

)

Gets the application version.

Renvoie

string

Références Application\$version.

Référencé par JsonDescriptor\describeApplication(), XmlDescriptor\getApplicationDocument(), MarkdownDescriptor\getApplicationTitle(), et Application\getLongVersion().

has()

has

(

string

$name

)

Returns true if the command exists, false otherwise.

Renvoie

bool

Références Application\$name, Application\add(), et Application\init().

Référencé par Application\all(), Application\find(), et Application\get().

init()

init ( )

private

Références Application\add(), et Application\getDefaultCommands().

Référencé par Application\add(), Application\all(), Application\find(), Application\get(), et Application\has().

isAutoExitEnabled()

isAutoExitEnabled

(

)

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

Renvoie

bool

Références Application\$autoExit.

isSingleCommand()

isSingleCommand

(

)

Références Application\$singleCommand.

register()

register

(

string

$name

)

Registers a new command.

Renvoie

Command

Références Application\$name, et Application\add().

renderThrowable()

renderThrowable	(	\Throwable	$e,
		OutputInterface	$output
	)

Références $output, Application\doRenderThrowable(), OutputFormatter\escape(), Application\getName(), null, OutputInterface\VERBOSITY_QUIET, et OutputInterface\writeln().

Référencé par Application\run().

reset()

reset

(

)

{}

Implémente ResetInterface.

Référencé par Application\find(), et Application\findNamespace().

run()

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

Runs the current application.

Renvoie

int 0 if everything went fine, or an error code

Exceptions

Références $errorHandler, $input, $output, Application\configureIO(), Application\doRun(), elseif, null, et Application\renderThrowable().

setAutoExit()

setAutoExit

(

bool

$boolean

)

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

setCatchExceptions()

setCatchExceptions

(

bool

$boolean

)

Sets whether to catch exceptions or not during commands execution.

setCommandLoader()

setCommandLoader

(

CommandLoaderInterface

$commandLoader

)

Références Application\$commandLoader.

setDefaultCommand()

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

Sets the default Command name.

Renvoie

$this

Références $this, et Application\find().

setDefinition()

setDefinition

(

InputDefinition

$definition

)

Références Application\$definition.

setDispatcher()

setDispatcher

(

EventDispatcherInterface

$dispatcher

)

Références Application\$dispatcher.

setHelperSet()

setHelperSet

(

HelperSet

$helperSet

)

Références Application\$helperSet.

setName()

setName

(

string

$name

)

Sets the application name.

Références Application\$name, et name.

setSignalsToDispatchEvent()

setSignalsToDispatchEvent

(

int ...

$signalsToDispatchEvent

)

Références Application\$signalsToDispatchEvent.

setVersion()

setVersion

(

string

$version

)

Sets the application version.

Références Application\$version.

splitStringByWidth()

splitStringByWidth ( string  $string, int  $width  )

private

Références Joomla\Database\Query\$offset, $width, et null.

Référencé par Application\doRenderThrowable().

Documentation des champs

$autoExit

$autoExit = true

private

Référencé par Application\isAutoExitEnabled().

$catchExceptions

$catchExceptions = true

private

Référencé par Application\areExceptionsCaught().

$commandLoader

$commandLoader

private

Référencé par Application\setCommandLoader().

$commands

$commands = []

private

Référencé par Application\addCommands(), Application\all(), et Application\find().

$defaultCommand

$defaultCommand

private

Référencé par Application\doRun().

$definition

$definition

private

Référencé par Application\doRun(), Application\getDefinition(), et Application\setDefinition().

$dispatcher

$dispatcher

private

Référencé par Application\setDispatcher().

$helperSet

$helperSet

private

Référencé par Application\getHelperSet(), et Application\setHelperSet().

$initialized

$initialized

private

$name

$name

private

Référencé par Application\__construct(), Application\all(), Application\doRun(), Application\extractAllNamespaces(), Application\extractNamespace(), Application\find(), Application\findAlternatives(), Application\get(), Application\getAbbreviations(), Application\getName(), Application\has(), Application\register(), et Application\setName().

$runningCommand

$runningCommand

private

$signalRegistry

$signalRegistry

private

Référencé par Application\getSignalRegistry().

$signalsToDispatchEvent

$signalsToDispatchEvent = []

private

Référencé par Application\setSignalsToDispatchEvent().

$singleCommand

$singleCommand = false

private

Référencé par Application\isSingleCommand().

$terminal

$terminal

private

$version

$version

private

Référencé par Application\__construct(), Application\getVersion(), et Application\setVersion().

$wantHelps

$wantHelps = false

private

---

La documentation de cette classe a été générée à partir du fichier suivant :

• libraries/vendor/symfony/console/Application.php