Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe CompletionSuggestions

Fonctions membres publiques

 suggestValue ($value)
 
 suggestValues (array $values)
 
 suggestOption (InputOption $option)
 
 suggestOptions (array $options)
 
 getOptionSuggestions ()
 
 getValueSuggestions ()
 

Attributs privés

 $valueSuggestions = []
 
 $optionSuggestions = []
 

Description détaillée

Stores all completion suggestions for the current input.

Auteur
Wouter de Jong woute.nosp@m.r@wo.nosp@m.uterj.nosp@m..nl

Documentation des fonctions membres

◆ getOptionSuggestions()

getOptionSuggestions ( )
Renvoie
InputOption[]

Références CompletionSuggestions\$optionSuggestions.

Référencé par BashCompletionOutput\write().

◆ getValueSuggestions()

getValueSuggestions ( )

◆ suggestOption()

suggestOption ( InputOption  $option)

Add a suggestion for an input option name.

Renvoie
$this

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

Référencé par CompletionSuggestions\suggestOptions().

◆ suggestOptions()

suggestOptions ( array  $options)

Add multiple suggestions for input option names at once.

Paramètres
InputOption[]$options
Renvoie
$this

Références $option, $options, $this, et CompletionSuggestions\suggestOption().

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

◆ suggestValue()

suggestValue (   $value)

Add a suggested value for an input option or argument.

Paramètres
string | Suggestion$value
Renvoie
$this

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

Référencé par CompletionSuggestions\suggestValues().

◆ suggestValues()

suggestValues ( array  $values)

Add multiple suggested values at once for an input option or argument.

Paramètres
list<string|Suggestion>$values
Renvoie
$this

Références $this, $value, et CompletionSuggestions\suggestValue().

Référencé par DumpCompletionCommand\complete(), HelpCommand\complete(), ServerDumpCommand\complete(), LintCommand\complete(), et Application\complete().

Documentation des champs

◆ $optionSuggestions

$optionSuggestions = []
private

◆ $valueSuggestions

$valueSuggestions = []
private

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