Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe CliApplication
+ Graphe d'héritage de CliApplication:

Fonctions membres publiques

 __construct (Cli $input=null, Registry $config=null, \JEventDispatcher $dispatcher=null)
 
 execute ()
 
 loadConfiguration ($data)
 
 out ($text='', $nl=true)
 
 getOutput ()
 
 setOutput (CliOutput $output)
 
 in ()
 
- Fonctions membres publiques hérités de BaseApplication
 __construct (Input $input=null, Registry $config=null)
 
 getIdentity ()
 
 registerEvent ($event, $handler)
 
 triggerEvent ($event, array $args=null)
 
 loadDispatcher (\JEventDispatcher $dispatcher=null)
 
 loadIdentity (\JUser $identity=null)
 
- Fonctions membres publiques hérités de AbstractApplication
 __construct (Input $input=null, Registry $config=null)
 
 close ($code=0)
 
 execute ()
 
 get ($key, $default=null)
 
 getLogger ()
 
 set ($key, $value=null)
 
 setConfiguration (Registry $config)
 
 setLogger (LoggerInterface $logger)
 

Fonctions membres publiques statiques

static getInstance ($name=null)
 

Fonctions membres protégées

 fetchConfigurationData ($file='', $class='\JConfig')
 
- Fonctions membres protégées hérités de BaseApplication
 doExecute ()
 
- Fonctions membres protégées hérités de AbstractApplication
 doExecute ()
 
 initialise ()
 

Attributs protégés

 $output
 
- Attributs protégés hérités de BaseApplication
 $dispatcher
 
 $identity
 
- 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 AbstractApplication
 $input = null
 

Description détaillée

Base class for a Joomla! command line application.

Depuis
11.4
Note
As of 4.0 this class will be abstract

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( Cli  $input = null,
Registry  $config = null,
\JEventDispatcher  $dispatcher = null 
)

Class constructor.

Paramètres
Cli$inputAn optional argument to provide dependency injection for the application's input object. If the argument is a object that object will become the application's input object, otherwise a default input object is created.
Registry$configAn 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.
\JEventDispatcher$dispatcherAn optional argument to provide dependency injection for the application's event dispatcher. If the argument is a 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.
Voir également
BaseApplication::loadDispatcher()
Depuis
11.1

Références $config, $dispatcher, et $input.

Documentation des fonctions membres

◆ execute()

execute ( )

Execute the application.

Renvoie
void
Depuis
11.1

◆ fetchConfigurationData()

fetchConfigurationData (   $file = '',
  $class = '\JConfig' 
)
protected

Method to load a PHP configuration class file based on convention and return the instantiated data object. You will extend this method in child classes to provide configuration data from whatever data source is relevant for your specific application.

Paramètres
string$fileThe path and filename of the configuration file. If not provided, configuration.php in JPATH_CONFIGURATION will be used.
string$classThe class name to instantiate.
Renvoie
mixed Either an array or object to be loaded into the configuration object.
Depuis
11.1

Références $class, $config, $file, JPATH_CONFIGURATION, et JLoader\register().

◆ 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$nameThe name (optional) of the JApplicationCli class to instantiate.
Renvoie
CliApplication
Depuis
11.1

Références $name.

◆ getOutput()

getOutput ( )

Get an output object.

Renvoie
CliOutput
Depuis
3.3

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

◆ in()

in ( )

Get a value from standard input.

Renvoie
string The input string from standard input.
Depuis
11.1

◆ loadConfiguration()

loadConfiguration (   $data)

Load an object or array into the application configuration object.

Paramètres
mixed$dataEither an array or object to be loaded into the configuration object.
Renvoie
CliApplication Instance of $this to allow chaining.
Depuis
11.1

Références $data, et elseif.

◆ out()

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

Write a string to standard output.

Paramètres
string$textThe text to display.
boolean$nlTrue (default) to append a new line at the end of the output string.
Renvoie
CliApplication Instance of $this to allow chaining.
Depuis
11.1

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

◆ setOutput()

setOutput ( CliOutput  $output)

Set an output object.

Paramètres
CliOutput$outputCliOutput object
Renvoie
CliApplication Instance of $this to allow chaining.
Depuis
3.3

Références $output.

Documentation des champs

◆ $instance

$instance
staticprotected

◆ $output

$output
protected

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