Référence de la classe Application

Graphe d'héritage de Application:

Fonctions membres publiques
	__construct (?InputInterface $input=null, ?OutputInterface $output=null, ?Registry $config=null)
	addCommand (AbstractCommand $command)
	execute ()
	findNamespace (string $namespace)
	getAllCommands (string $namespace='')
	getCommands ()
	getConsoleInput ()
	getConsoleOutput ()
	getDefinition ()
	getHelperSet ()
	getLongVersion ()
	getName ()
	getNamespaces ()
	getVersion ()
	hasCommand (string $name)
	renderThrowable (\Throwable $throwable)
	setAutoExit (bool $autoExit)
	setCatchThrowables (bool $catchThrowables)
	setCommandLoader (Loader\LoaderInterface $loader)
	setHelperSet (HelperSet $helperSet)
	setName (string $name)
	setVersion (string $version)
	shouldAutoExit ()
	shouldCatchThrowables ()
Fonctions membres publiques hérités de AbstractApplication
	__construct (Registry $config=null)
	close ($code=0)
	execute ()
	get ($key, $default=null)
	getLogger ()
	set ($key, $value=null)
	setConfiguration (Registry $config)
Fonctions membres publiques hérités de LoggerAwareInterface
	setLogger (LoggerInterface $logger)
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)

Fonctions membres protégées
	configureIO ()
	doExecute ()
	getCommandName (InputInterface $input)
	getDefaultCommands ()
	getDefaultInputDefinition ()
	getDefaultHelperSet ()
	initialise ()
	doRenderThrowable (\Throwable $throwable, OutputInterface $output)
	runCommand (AbstractCommand $command, InputInterface $input, OutputInterface $output)
Fonctions membres protégées hérités de AbstractApplication
	dispatchEvent (string $eventName, ?EventInterface $event=null)
	doExecute ()
	initialise ()

Fonctions membres privées
	splitStringByWidth (string $string, int $width)
	extractAllNamespaces (string $name)
	extractNamespace (string $name, ?int $limit=null)
	initCommands ()

Attributs privés
	$autoExit = true
	$catchThrowables = true
	$commands = []
	$commandLoader
	$consoleInput
	$consoleOutput
	$defaultCommand = 'list'
	$definition
	$helperSet
	$initialised = false
	$name = ''
	$runningCommand
	$terminal
	$version = ''
	$wantsHelp = false

Membres hérités additionnels
Attributs protégés hérités de AbstractApplication
	$config

Description détaillée

Base application class for a Joomla! command line application.

Depuis

2.0.0

Documentation des constructeurs et destructeur

__construct()

__construct	(	?InputInterface	$input = null,
		?OutputInterface	$output = null,
		?Registry	$config = null
	)

Class constructor.

Paramètres

InputInterface	$input	An optional argument to provide dependency injection for the application's input object. If the argument is an InputInterface object that object will become the application's input object, otherwise a default input object is created.
OutputInterface	$output	An optional argument to provide dependency injection for the application's output object. If the argument is an OutputInterface object that object will become the application's output object, otherwise a default output object is created.
Registry	$config	An optional argument to provide dependency injection for the application's config object. If the argument is a Registry object that object will become the application's config object, otherwise a default config object is created.

Depuis

2.0.0

Références AbstractApplication\$config, $input, $output, Symfony\Contracts\Service\__construct(), et AbstractApplication\close().

Documentation des fonctions membres

addCommand()

addCommand

(

AbstractCommand

$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.

Paramètres

AbstractCommand

$command

The command to add to the application.

Renvoie

AbstractCommand

Depuis

2.0.0

Exceptions

LogicException

Références $this, AbstractCommand\getAliases(), AbstractCommand\getDefinition(), AbstractCommand\getName(), Application\initCommands(), AbstractCommand\isEnabled(), et AbstractCommand\setApplication().

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

configureIO()

configureIO ( )

protected

Configures the console input and output instances for the process.

Renvoie

void

Depuis

2.0.0

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

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

doExecute()

doExecute ( )

protected

Method to run the application routines.

Renvoie

integer The exit code for the application

Depuis

2.0.0

Exceptions

Références Application\$consoleInput, Application\$consoleOutput, Application\$defaultCommand, Application\$definition, $input, Application\$name, $output, $this, block, ConsoleEvents\COMMAND_ERROR, AbstractApplication\dispatchEvent(), Application\getCommandName(), Application\getDefinition(), Application\getLongVersion(), null, InputArgument\OPTIONAL, et Application\runCommand().

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

doRenderThrowable()

doRenderThrowable ( \Throwable  $throwable, OutputInterface  $output  )

protected

Handles recursively rendering error messages for a Throwable and all previous Throwables contained within.

Paramètres

\Throwable	$throwable	The Throwable object to render the message for.
OutputInterface	$output	The output object to send the message to.

Renvoie

void

Depuis

2.0.0

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

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

execute()

execute

(

)

Execute the application.

Renvoie

void

Depuis

2.0.0

Exceptions

Implémente ApplicationInterface.

Références $errorHandler, $this, ApplicationEvents\AFTER_EXECUTE, ConsoleEvents\APPLICATION_ERROR, ApplicationEvents\BEFORE_EXECUTE, AbstractApplication\close(), Application\configureIO(), AbstractApplication\dispatchEvent(), Application\doExecute(), elseif, null, Application\renderThrowable(), Application\shouldAutoExit(), et Application\shouldCatchThrowables().

extractAllNamespaces()

extractAllNamespaces ( string  $name )

private

Returns all namespaces of the command name.

Paramètres

string

$name

The full name of the command

Renvoie

string[]

Depuis

2.0.0

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

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

extractNamespace()

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

private

Returns the namespace part of the command name.

Paramètres

string	$name	The command name to process
integer	$limit	The maximum number of parts of the namespace

Renvoie

string

Depuis

2.0.0

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

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

findNamespace()

findNamespace

(

string

$namespace

)

Finds a registered namespace by a name.

Paramètres

string

$namespace

A namespace to search for

Renvoie

string

Depuis

2.0.0

Exceptions

NamespaceNotFoundException

When namespace is incorrect or ambiguous

Références $namespace, et Application\getNamespaces().

getAllCommands()

getAllCommands

(

string

$namespace = ''

)

Gets all commands, including those available through a command loader, optionally filtered on a command namespace.

Paramètres

string

$namespace

An optional command namespace to filter by.

Renvoie

AbstractCommand[]

Depuis

2.0.0

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

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

getCommandName()

getCommandName ( InputInterface  $input )

protected

Get the name of the command to run.

Paramètres

InputInterface

$input

The input to read the argument from

Renvoie

string|null

Depuis

2.0.0

Références $input.

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

getCommands()

getCommands

(

)

Get the registered commands.

This method only retrieves commands which have been explicitly registered. To get all commands including those from a command loader, use the getAllCommands() method.

Renvoie

AbstractCommand[]

Depuis

2.0.0

Références Application\$commands.

getConsoleInput()

getConsoleInput

(

)

Get the console input handler.

Renvoie

InputInterface

Depuis

2.0.0

Références Application\$consoleInput.

getConsoleOutput()

getConsoleOutput

(

)

Get the console output handler.

Renvoie

OutputInterface

Depuis

2.0.0

Références Application\$consoleOutput.

getDefaultCommands()

getDefaultCommands ( )

protected

Get the commands which should be registered by default to the application.

Renvoie

AbstractCommand[]

Depuis

2.0.0

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

getDefaultHelperSet()

getDefaultHelperSet ( )

protected

Builds the default helper set.

Renvoie

HelperSet

Depuis

2.0.0

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

getDefaultInputDefinition()

getDefaultInputDefinition ( )

protected

Builds the default input definition.

Renvoie

InputDefinition

Depuis

2.0.0

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

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

getDefinition()

getDefinition

(

)

Gets the InputDefinition related to this Application.

Renvoie

InputDefinition

Depuis

2.0.0

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

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

getHelperSet()

getHelperSet

(

)

Get the helper set associated with the application.

Renvoie

HelperSet

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

getLongVersion()

getLongVersion

(

)

Get the long version string for the application.

Typically, this is the application name and version and is used in the application help output.

Renvoie

string

Depuis

2.0.0

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

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

getName()

getName

(

)

Get the name of the application.

Renvoie

string

Depuis

2.0.0

Références Application\$name.

Référencé par Application\getLongVersion(), et Application\renderThrowable().

getNamespaces()

getNamespaces

(

)

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

Note that this does not include the global namespace which always exists.

Renvoie

string[]

Depuis

2.0.0

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

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

getVersion()

getVersion

(

)

Get the version of the application.

Renvoie

string

Depuis

2.0.0

Références Application\$version.

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

hasCommand()

hasCommand

(

string

$name

)

Check if the application has a command with the given name.

Paramètres

string

$name

The name of the command to check for existence.

Renvoie

boolean

Depuis

2.0.0

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

initCommands()

initCommands ( )

private

Internal function to initialise the command store, this allows the store to be lazy loaded only when needed.

Renvoie

void

Depuis

2.0.0

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

Référencé par Application\addCommand(), Application\getAllCommands(), et Application\hasCommand().

initialise()

initialise ( )

protected

Custom initialisation method.

Renvoie

void

Depuis

2.0.0

renderThrowable()

renderThrowable

(

\Throwable

$throwable

)

Renders an error message for a Throwable object

Paramètres

\Throwable

$throwable

The Throwable object to render the message for.

Renvoie

void

Depuis

2.0.0

Références Application\$consoleOutput, $output, Application\doRenderThrowable(), ConsoleOutputInterface\getErrorOutput(), Application\getName(), null, et OutputInterface\VERBOSITY_QUIET.

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

runCommand()

runCommand ( AbstractCommand  $command, InputInterface  $input, OutputInterface  $output  )

protected

Run the given command.

Paramètres

AbstractCommand	$command	The command to run.
InputInterface	$input	The input to inject into the command.
OutputInterface	$output	The output to inject into the command.

Renvoie

integer

Depuis

2.0.0

Exceptions

Références $helper, $input, $output, $this, ConsoleEvents\BEFORE_COMMAND_EXECUTE, ConsoleEvents\COMMAND_ERROR, AbstractApplication\dispatchEvent(), AbstractCommand\execute(), AbstractCommand\getDefinition(), Joomla\CMS\Application\getDispatcher(), AbstractCommand\getHelperSet(), AbstractCommand\mergeApplicationDefinition(), null, BeforeCommandExecuteEvent\RETURN_CODE_DISABLED, et ConsoleEvents\TERMINATE.

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

setAutoExit()

setAutoExit

(

bool

$autoExit

)

Set whether the application should auto exit.

Paramètres

boolean

$autoExit

The auto exit state.

Renvoie

void

Depuis

2.0.0

Références Application\$autoExit.

setCatchThrowables()

setCatchThrowables

(

bool

$catchThrowables

)

Set whether the application should catch Throwables.

Paramètres

boolean

$catchThrowables

The catch Throwables state.

Renvoie

void

Depuis

2.0.0

Références Application\$catchThrowables.

setCommandLoader()

setCommandLoader

(

Loader\LoaderInterface

$loader

)

Set the command loader.

Paramètres

Loader\LoaderInterface

$loader

The new command loader.

Renvoie

void

Depuis

2.0.0

Références $loader.

setHelperSet()

setHelperSet

(

HelperSet

$helperSet

)

Set the application's helper set.

Paramètres

HelperSet

$helperSet

The new HelperSet.

Renvoie

void

Depuis

2.0.0

Références Application\$helperSet.

setName()

setName

(

string

$name

)

Set the name of the application.

Paramètres

string

$name

The new application name.

Renvoie

void

Depuis

2.0.0

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

setVersion()

setVersion

(

string

$version

)

Set the version of the application.

Paramètres

string

$version

The new application version.

Renvoie

void

Depuis

2.0.0

Références Application\$version.

shouldAutoExit()

shouldAutoExit

(

)

Get the application's auto exit state.

Renvoie

boolean

Depuis

2.0.0

Références Application\$autoExit.

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

shouldCatchThrowables()

shouldCatchThrowables

(

)

Get the application's catch Throwables state.

Renvoie

boolean

Depuis

2.0.0

Références Application\$catchThrowables.

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

splitStringByWidth()

splitStringByWidth ( string  $string, int  $width  )

private

Splits a string for a specified width for use in an output.

Paramètres

string	$string	The string to split.
integer	$width	The maximum width of the output.

Renvoie

string[]

Depuis

2.0.0

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\setAutoExit(), et Application\shouldAutoExit().

$catchThrowables

$catchThrowables = true

private

Référencé par Application\setCatchThrowables(), et Application\shouldCatchThrowables().

$commandLoader

$commandLoader

private

$commands

$commands = []

private

Référencé par Application\getAllCommands(), et Application\getCommands().

$consoleInput

$consoleInput

private

Référencé par Application\doExecute(), et Application\getConsoleInput().

$consoleOutput

$consoleOutput

private

Référencé par Application\doExecute(), Application\getConsoleOutput(), et Application\renderThrowable().

$defaultCommand

$defaultCommand = 'list'

private

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

$definition

$definition

private

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

$helperSet

$helperSet

private

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

$initialised

$initialised = false

private

$name

$name = ''

private

Référencé par Application\doExecute(), Application\extractAllNamespaces(), Application\extractNamespace(), Application\getAllCommands(), Application\getLongVersion(), Application\getName(), Application\hasCommand(), et Application\setName().

$runningCommand

$runningCommand

private

$terminal

$terminal

private

$version

$version = ''

private

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

$wantsHelp

$wantsHelp = false

private

---

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

• libraries/vendor/joomla/console/src/Application.php