Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe ChoiceQuestion
+ Graphe d'héritage de ChoiceQuestion:

Fonctions membres publiques

 __construct (string $question, array $choices, $default=null)
 
 getChoices ()
 
 setMultiselect (bool $multiselect)
 
 isMultiselect ()
 
 getPrompt ()
 
 setPrompt (string $prompt)
 
 setErrorMessage (string $errorMessage)
 
- Fonctions membres publiques hérités de Question
 __construct (string $question, $default=null)
 
 getQuestion ()
 
 getDefault ()
 
 isMultiline ()
 
 setMultiline (bool $multiline)
 
 isHidden ()
 
 setHidden (bool $hidden)
 
 isHiddenFallback ()
 
 setHiddenFallback (bool $fallback)
 
 getAutocompleterValues ()
 
 setAutocompleterValues (?iterable $values)
 
 getAutocompleterCallback ()
 
 setAutocompleterCallback (callable $callback=null)
 
 setValidator (callable $validator=null)
 
 getValidator ()
 
 setMaxAttempts (?int $attempts)
 
 getMaxAttempts ()
 
 setNormalizer (callable $normalizer)
 
 getNormalizer ()
 
 isTrimmable ()
 
 setTrimmable (bool $trimmable)
 

Fonctions membres privées

 getDefaultValidator ()
 

Attributs privés

 $choices
 
 $multiselect = false
 
 $prompt = ' > '
 
 $errorMessage = 'Value "%s" is invalid'
 

Membres hérités additionnels

- Fonctions membres protégées hérités de Question
 isAssoc (array $array)
 

Description détaillée

Represents a choice question.

Auteur
Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( string  $question,
array  $choices,
  $default = null 
)
Paramètres
string$questionThe question to ask to the user
array$choicesThe list of available choices
mixed$defaultThe default answer to return

Références ChoiceQuestion\$choices, Question\$default, Question\$question, Symfony\Contracts\Service\__construct(), ChoiceQuestion\getDefaultValidator(), Question\setAutocompleterValues(), et Question\setValidator().

Documentation des fonctions membres

◆ getChoices()

getChoices ( )

Returns available choices.

Renvoie
array

Références ChoiceQuestion\$choices.

Référencé par QuestionHelper\formatChoiceQuestionChoices().

◆ getDefaultValidator()

◆ getPrompt()

getPrompt ( )

Gets the prompt for choices.

Renvoie
string

Références ChoiceQuestion\$prompt.

◆ isMultiselect()

isMultiselect ( )

Returns whether the choices are multiselect.

Renvoie
bool

Références ChoiceQuestion\$multiselect.

◆ setErrorMessage()

setErrorMessage ( string  $errorMessage)

Sets the error message for invalid values.

The error message has a string placeholder (s) for the invalid value.

Renvoie
$this

Références ChoiceQuestion\$errorMessage, $this, ChoiceQuestion\getDefaultValidator(), et Question\setValidator().

◆ setMultiselect()

setMultiselect ( bool  $multiselect)

Sets multiselect option.

When multiselect is set to true, multiple choices can be answered.

Renvoie
$this

Références ChoiceQuestion\$multiselect, $this, ChoiceQuestion\getDefaultValidator(), et Question\setValidator().

◆ setPrompt()

setPrompt ( string  $prompt)

Sets the prompt for choices.

Renvoie
$this

Références ChoiceQuestion\$prompt, et $this.

Documentation des champs

◆ $choices

◆ $errorMessage

$errorMessage = 'Value "%s" is invalid'
private

◆ $multiselect

◆ $prompt

$prompt = ' > '
private

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