Référence de la classe CliApplication

Graphe d'héritage de CliApplication:

Fonctions membres publiques
	__construct (Input $input=null, Registry $config=null, CliOutput $output=null, CliInput $cliInput=null, DispatcherInterface $dispatcher=null, Container $container=null)
	__get ($name)
	getInput ()
	getLanguage ()
	execute ()
	getOutput ()
	getCliInput ()
	out ($text='', $nl=true)
	in ()
	setOutput (CliOutput $output)
	enqueueMessage ($msg, $type=self::MSG_INFO)
	getMessageQueue ()
	isClient ($identifier)
	getSession ()
	getConfig ()
	isCli ()
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 publiques hérités de CMSApplicationInterface
	getIdentity ()
	getName ()
	loadIdentity (User $identity=null)
Fonctions membres publiques hérités de ExtensionManagerInterface
	bootComponent ($component)
	bootModule ($module, $applicationName)
	bootPlugin ($plugin, $type)
Fonctions membres publiques hérités de EventAwareInterface
	getDispatcher ()
	triggerEvent ($eventName, $args=[])

Fonctions membres publiques statiques
static	getInstance ($name=null)

Attributs protégés
	$output
	$input = null
	$cliInput
	$language
	$messages = []
Attributs protégés hérités de AbstractApplication
	$config

Attributs protégés statiques
static	$instance

Membres hérités additionnels
Champs de données hérités de CMSApplicationInterface
const	MSG_EMERGENCY = 'emergency'
const	MSG_ALERT = 'alert'
const	MSG_CRITICAL = 'critical'
const	MSG_ERROR = 'error'
const	MSG_WARNING = 'warning'
const	MSG_NOTICE = 'notice'
const	MSG_INFO = 'info'
const	MSG_DEBUG = 'debug'
Fonctions membres protégées hérités de AbstractApplication
	dispatchEvent (string $eventName, ?EventInterface $event=null)
	doExecute ()
	initialise ()

Description détaillée

Base class for a Joomla! command line application.

Depuis

2.5.0

Obsolète:

5.0 Use the ConsoleApplication instead

Documentation des constructeurs et destructeur

__construct()

__construct	(	Input	$input = null,
		Registry	$config = null,
		CliOutput	$output = null,
		CliInput	$cliInput = null,
		DispatcherInterface	$dispatcher = null,
		Container	$container = null
	)

Class constructor.

Paramètres

Input	$input	An optional argument to provide dependency injection for the application's input object. If the argument is a JInputCli object that object will become the application's input object, otherwise a default input 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.
CliOutput	$output	The output handler.
CliInput	$cliInput	The CLI input handler.
DispatcherInterface	$dispatcher	An optional argument to provide dependency injection for the application's event dispatcher. If the argument is a DispatcherInterface object that object will become the application's event dispatcher, if it is null then the default event dispatcher will be created based on the application's loadDispatcher() method.
Container	$container	Dependency injection container.

Depuis

1.7.0

Références $config, $container, $output, Symfony\Contracts\Service\__construct(), class, Factory\getContainer(), Factory\getLanguage(), language, Joomla\DI\setContainer(), et Joomla\Event\setDispatcher().

Documentation des fonctions membres

__get()

__get

(

$name

)

Magic method to access properties of the application.

Paramètres

string

$name

The name of the property.

Renvoie

mixed A value if the property name is valid, null otherwise.

Depuis

4.0.0

Obsolète:

5.0 This is a B/C proxy for deprecated read accesses

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

enqueueMessage()

enqueueMessage	(		$msg,
			$type = self::MSG_INFO
	)

Enqueue a system message.

Paramètres

string	$msg	The message to enqueue.
string	$type	The message type.

Renvoie

void

Depuis

4.0.0

Implémente CMSApplicationInterface.

Références $type.

execute()

execute

(

)

Execute the application.

Renvoie

void

Depuis

1.7.0

Implémente ApplicationInterface.

Références Joomla\CMS\Application\triggerEvent().

getCliInput()

getCliInput

(

)

Get a CLI input object.

Renvoie

CliInput

Depuis

4.0.0

getConfig()

getConfig

(

)

Retrieve the application configuration object.

Renvoie

Registry

Depuis

4.0.0

Références $config.

getInput()

getInput

(

)

Method to get the application input object.

Renvoie

Input

Depuis

4.0.0

Implémente CMSApplicationInterface.

Références $input.

getInstance()

static getInstance (   $name = null )

static

Returns a reference to the global CliApplication object, only creating it if it doesn't already exist.

This method must be invoked as: $cli = CliApplication::getInstance();

Paramètres

string

$name

The name (optional) of the Application Cli class to instantiate.

Renvoie

CliApplication

Depuis

1.7.0

Obsolète:

5.0 Load the app through the container

Exceptions

Références $name.

getLanguage()

getLanguage

(

)

Method to get the application language object.

Renvoie

Language The language object

Depuis

4.0.0

Implémente CMSApplicationInterface.

Références $language.

getMessageQueue()

getMessageQueue

(

)

Get the system message queue.

Renvoie

array The system message queue.

Depuis

4.0.0

Implémente CMSApplicationInterface.

Références $messages.

getOutput()

getOutput

(

)

Get an output object.

Renvoie

CliOutput

Depuis

4.0.0

Références $output.

getSession()

getSession

(

)

Method to get the application session object.

Renvoie

SessionInterface The session object

Depuis

4.0.0

Références class.

in()

in

(

)

Get a value from standard input.

Renvoie

string The input string from standard input.

Depuis

4.0.0

isCli()

isCli

(

)

Flag if the application instance is a CLI or web based application.

Helper function, you should use the native PHP functions to detect if it is a CLI application.

Renvoie

boolean

Depuis

4.0.0

Obsolète:

5.0 Will be removed without replacements

Implémente CMSApplicationInterface.

isClient()

isClient

(

$identifier

)

Check the client interface by name.

Paramètres

string

$identifier

String identifier for the application interface

Renvoie

boolean True if this application is of the given type client interface.

Depuis

4.0.0

Implémente CMSApplicationInterface.

out()

out	(		$text = '',
			$nl = true
	)

Write a string to standard output.

Paramètres

string	$text	The text to display.
boolean	$nl	True (default) to append a new line at the end of the output string.

Renvoie

$this

Depuis

4.0.0

Références $text, $this, et Symfony\Component\Console\Tester\getOutput().

setOutput()

setOutput

(

CliOutput

$output

)

Set an output object.

Paramètres

CliOutput

$output

CliOutput object

Renvoie

$this

Depuis

3.3

Références $output, et $this.

Documentation des champs

$cliInput

$cliInput

protected

$input

$input = null

protected

$instance

$instance

staticprotected

$language

$language

protected

$messages

$messages = []

protected

$output

$output

protected

---

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

• CliApplication.php