Référence de la classe Question

Graphe d'héritage de Question:

Fonctions membres publiques
	__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 protégées
	isAssoc (array $array)

Attributs privés
	$question
	$attempts
	$hidden = false
	$hiddenFallback = true
	$autocompleterCallback
	$validator
	$default
	$normalizer
	$trimmable = true
	$multiline = false

Description détaillée

Represents a Question.

Auteur

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

Documentation des constructeurs et destructeur

__construct()

__construct	(	string	$question,
			$default = null
	)

Paramètres

string	$question	The question to ask to the user
string | bool | int | float | null	$default	The default answer to return if the user enters nothing

Références Question\$default, et Question\$question.

Documentation des fonctions membres

getAutocompleterCallback()

getAutocompleterCallback

(

)

Gets the callback function used for the autocompleter.

Références Question\$autocompleterCallback.

Référencé par QuestionHelper\doAsk(), et Question\getAutocompleterValues().

getAutocompleterValues()

getAutocompleterValues

(

)

Gets values for the autocompleter.

Renvoie

iterable|null

Références Question\getAutocompleterCallback(), et null.

getDefault()

getDefault

(

)

Returns the default answer.

Renvoie

string|bool|int|float|null

Références Question\$default.

Référencé par QuestionHelper\autocomplete(), QuestionHelper\doAsk(), QuestionHelper\getDefaultAnswer(), ConfirmationQuestion\getDefaultNormalizer(), et SymfonyQuestionHelper\writePrompt().

getMaxAttempts()

getMaxAttempts

(

)

Gets the maximum number of attempts.

Null means an unlimited number of attempts.

Renvoie

int|null

Références Question\$attempts.

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

getNormalizer()

getNormalizer

(

)

Gets the normalizer for the response.

The normalizer can ba a callable (a string), a closure or a class implementing __invoke.

Renvoie

callable|null

Références Question\$normalizer.

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

getQuestion()

getQuestion

(

)

Returns the question.

Renvoie

string

Références Question\$question.

Référencé par SymfonyQuestionHelper\writePrompt(), et QuestionHelper\writePrompt().

getValidator()

getValidator

(

)

Gets the validator for the question.

Renvoie

callable|null

Références Question\$validator.

Référencé par QuestionHelper\ask(), QuestionHelper\getDefaultAnswer(), et QuestionHelper\validateAttempts().

isAssoc()

isAssoc ( array  $array )

protected

Référencé par ChoiceQuestion\getDefaultValidator(), et Question\setAutocompleterValues().

isHidden()

isHidden

(

)

Returns whether the user response must be hidden.

Renvoie

bool

Références Question\$hidden.

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

isHiddenFallback()

isHiddenFallback

(

)

In case the response cannot be hidden, whether to fallback on non-hidden question or not.

Renvoie

bool

Références Question\$hiddenFallback.

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

isMultiline()

isMultiline

(

)

Returns whether the user response accepts newline characters.

Références Question\$multiline.

Référencé par QuestionHelper\readInput(), et SymfonyQuestionHelper\writePrompt().

isTrimmable()

isTrimmable

(

)

Références Question\$trimmable.

Référencé par QuestionHelper\doAsk(), QuestionHelper\getDefaultAnswer(), et ChoiceQuestion\getDefaultValidator().

setAutocompleterCallback()

setAutocompleterCallback

(

callable

$callback = null

)

Sets the callback function used for the autocompleter.

The callback is passed the user input as argument and should return an iterable of corresponding suggestions.

Renvoie

$this

Références $this, et null.

Référencé par Question\setAutocompleterValues().

setAutocompleterValues()

setAutocompleterValues

(

?iterable

$values

)

Sets values for the autocompleter.

Renvoie

$this

Exceptions

LogicException

Références elseif, Question\isAssoc(), null, et Question\setAutocompleterCallback().

Référencé par ChoiceQuestion\__construct().

setHidden()

setHidden

(

bool

$hidden

)

Sets whether the user response must be hidden or not.

Renvoie

$this

Exceptions

LogicException

In case the autocompleter is also used

Références Question\$hidden, et $this.

setHiddenFallback()

setHiddenFallback

(

bool

$fallback

)

Sets whether to fallback on non-hidden question if the response cannot be hidden.

Renvoie

$this

Références $this.

setMaxAttempts()

setMaxAttempts

(

?int

$attempts

)

Sets the maximum number of attempts.

Null means an unlimited number of attempts.

Renvoie

$this

Exceptions

InvalidArgumentException

in case the number of attempts is invalid

Références Question\$attempts, $this, et null.

setMultiline()

setMultiline

(

bool

$multiline

)

Sets whether the user response should accept newline characters.

Renvoie

$this

Références Question\$multiline, et $this.

setNormalizer()

setNormalizer

(

callable

$normalizer

)

Sets a normalizer for the response.

The normalizer can be a callable (a string), a closure or a class implementing __invoke.

Renvoie

$this

Références Question\$normalizer, et $this.

Référencé par ConfirmationQuestion\__construct().

setTrimmable()

setTrimmable

(

bool

$trimmable

)

Renvoie

$this

Références $this, et Question\$trimmable.

setValidator()

setValidator

(

callable

$validator = null

)

Sets a validator for the question.

Renvoie

$this

Références $this, et Question\$validator.

Référencé par ChoiceQuestion\__construct(), ChoiceQuestion\setErrorMessage(), et ChoiceQuestion\setMultiselect().

Documentation des champs

$attempts

$attempts

private

Référencé par Question\getMaxAttempts(), et Question\setMaxAttempts().

$autocompleterCallback

$autocompleterCallback

private

Référencé par Question\getAutocompleterCallback().

$default

$default

private

Référencé par ConfirmationQuestion\__construct(), ChoiceQuestion\__construct(), Question\__construct(), Question\getDefault(), et ConfirmationQuestion\getDefaultNormalizer().

$hidden

$hidden = false

private

Référencé par Question\isHidden(), et Question\setHidden().

$hiddenFallback

$hiddenFallback = true

private

Référencé par Question\isHiddenFallback().

$multiline

$multiline = false

private

Référencé par Question\isMultiline(), et Question\setMultiline().

$normalizer

$normalizer

private

Référencé par Question\getNormalizer(), et Question\setNormalizer().

$question

$question

private

Référencé par ConfirmationQuestion\__construct(), ChoiceQuestion\__construct(), Question\__construct(), et Question\getQuestion().

$trimmable

$trimmable = true

private

Référencé par Question\isTrimmable(), et Question\setTrimmable().

$validator

$validator

private

Référencé par Question\getValidator(), et Question\setValidator().

---

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

• Question.php