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 AbstractCliApplication
+ Graphe d'héritage de AbstractCliApplication:

Fonctions membres publiques

 __construct (Input\Cli $input=null, Registry $config=null, Cli\CliOutput $output=null, Cli\CliInput $cliInput=null)
 
 getOutput ()
 
 getCliInput ()
 
 out ($text='', $nl=true)
 
 in ()
 
- 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)
 

Attributs protégés

 $output
 
 $cliInput
 
- Attributs protégés hérités de AbstractApplication
 $config
 

Membres hérités additionnels

- Champs de données hérités de AbstractApplication
 $input = null
 
- Fonctions membres protégées hérités de AbstractApplication
 doExecute ()
 
 initialise ()
 

Description détaillée

Base class for a Joomla! command line application.

Depuis
1.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( Input\Cli  $input = null,
Registry  $config = null,
Cli\CliOutput  $output = null,
Cli\CliInput  $cliInput = null 
)

Class constructor.

Paramètres
Input\Cli$inputAn optional argument to provide dependency injection for the application's input object. If the argument is an Input 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.
Cli\CliOutput$outputAn optional argument to provide dependency injection for the application's output object. If the argument is a Cli object that object will become the application's input object, otherwise a default output object is created.
Cli\CliInput$cliInputAn optional argument to provide dependency injection for the application's CLI input object. If the argument is a Cli object that object will become the application's input object, otherwise a default input object is created.
Depuis
1.0

Références AbstractCliApplication\$cliInput, AbstractApplication\$config, AbstractApplication\$input, AbstractCliApplication\$output, et AbstractApplication\close().

Documentation des fonctions membres

◆ getCliInput()

getCliInput ( )

Get a CLI input object.

Renvoie
Cli
Depuis
1.6.0

Références AbstractCliApplication\$cliInput.

Référencé par AbstractCliApplication\in().

◆ getOutput()

getOutput ( )

Get an output object.

Renvoie
Cli
Depuis
1.0

Références AbstractCliApplication\$output.

Référencé par AbstractCliApplication\out().

◆ in()

in ( )

Get a value from standard input.

Renvoie
string The input string from standard input.
Depuis
1.0

Références AbstractCliApplication\getCliInput().

◆ 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
AbstractCliApplication Instance of $this to allow chaining.
Depuis
1.0

Références $text, et AbstractCliApplication\getOutput().

Documentation des champs

◆ $cliInput

◆ $output


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