Référence de la classe QuestionHelper

Graphe d'héritage de QuestionHelper:

Fonctions membres publiques
	ask (InputInterface $input, OutputInterface $output, Question $question)
	getName ()
Fonctions membres publiques hérités de Helper
	setHelperSet (HelperSet $helperSet=null)
	getHelperSet ()

Fonctions membres publiques statiques
static	disableStty ()
Fonctions membres publiques statiques hérités de Helper
static	strlen (?string $string)
static	width (?string $string)
static	length (?string $string)
static	substr (?string $string, int $from, int $length=null)
static	formatTime ($secs)
static	formatMemory (int $memory)
static	strlenWithoutDecoration (OutputFormatterInterface $formatter, ?string $string)
static	removeDecoration (OutputFormatterInterface $formatter, ?string $string)

Fonctions membres protégées
	writePrompt (OutputInterface $output, Question $question)
	formatChoiceQuestionChoices (ChoiceQuestion $question, string $tag)
	writeError (OutputInterface $output, \Exception $error)

Fonctions membres privées
	doAsk (OutputInterface $output, Question $question)
	getDefaultAnswer (Question $question)
	autocomplete (OutputInterface $output, Question $question, $inputStream, callable $autocomplete)
	mostRecentlyEnteredValue (string $entered)
	getHiddenResponse (OutputInterface $output, $inputStream, bool $trimmable=true)
	validateAttempts (callable $interviewer, OutputInterface $output, Question $question)
	isInteractiveInput ($inputStream)
	readInput ($inputStream, Question $question)
	setIOCodepage ()
	resetIOCodepage (int $cp, $input)
	cloneInputStream ($inputStream)

Attributs privés
	$inputStream

Attributs privés statiques
static	$stty = true
static	$stdinIsInteractive

Membres hérités additionnels
Attributs protégés hérités de Helper
	$helperSet = null

Description détaillée

The QuestionHelper class provides helpers to interact with the user.

Auteur

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

Documentation des fonctions membres

ask()

ask	(	InputInterface	$input,
		OutputInterface	$output,
		Question	$question
	)

Asks a question to the user.

Renvoie

mixed The user answer

Exceptions

RuntimeException

If there is no data to read in the input stream

Références $input, $output, Laminas\Diactoros\$stream, QuestionHelper\doAsk(), QuestionHelper\getDefaultAnswer(), Question\getValidator(), null, et QuestionHelper\validateAttempts().

autocomplete()

autocomplete ( OutputInterface  $output, Question  $question,   $inputStream, callable  $autocomplete  )

private

Autocompletes a question.

Paramètres

resource

$inputStream

Références $autocomplete, $c, $i, QuestionHelper\$inputStream, $output, $r, $value, elseif, OutputFormatter\escapeTrailingBackslash(), Question\getDefault(), QuestionHelper\mostRecentlyEnteredValue(), null, Helper\strlen(), Helper\substr(), et Helper\width().

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

cloneInputStream()

cloneInputStream (   $inputStream )

private

Clones an input stream in order to act on one instance of the same stream without affecting the other instance.

Paramètres

resource

$inputStream

The handler resource

Renvoie

resource|null The cloned resource, null in case it could not be cloned

Références QuestionHelper\$inputStream, $mode, Joomla\Database\Query\$offset, $uri, et null.

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

disableStty()

static disableStty ( )

static

Prevents usage of stty.

doAsk()

doAsk ( OutputInterface  $output, Question  $question  )

private

Asks the question to the user.

Renvoie

mixed

Exceptions

RuntimeException

In case the fallback is deactivated and the response cannot be hidden

Références $autocomplete, QuestionHelper\$inputStream, $output, QuestionHelper\autocomplete(), Question\getAutocompleterCallback(), Question\getDefault(), QuestionHelper\getHiddenResponse(), Question\getNormalizer(), Terminal\hasSttyAvailable(), Question\isHidden(), Question\isHiddenFallback(), Question\isTrimmable(), null, QuestionHelper\readInput(), Helper\strlen(), et QuestionHelper\writePrompt().

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

formatChoiceQuestionChoices()

formatChoiceQuestionChoices ( ChoiceQuestion  $question, string  $tag  )

protected

Renvoie

string[]

Références $key, $messages, $value, ChoiceQuestion\getChoices(), et width.

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

getDefaultAnswer()

getDefaultAnswer ( Question  $question )

private

Renvoie

mixed

Références $default, elseif, Question\getDefault(), Question\getValidator(), Question\isTrimmable(), et null.

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

getHiddenResponse()

getHiddenResponse ( OutputInterface  $output,   $inputStream, bool  $trimmable = true  )

private

Gets a hidden response from user.

Paramètres

resource	$inputStream	The handler resource
bool	$trimmable	Is the answer trimmable

Exceptions

RuntimeException

In case the fallback is deactivated and the response cannot be hidden

Références QuestionHelper\$inputStream, $output, $value, __DIR__, elseif, Terminal\hasSttyAvailable(), QuestionHelper\isInteractiveInput(), et Helper\substr().

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

getName()

getName

(

)

{Returns the canonical name of this helper.

Renvoie

string

}

Implémente HelperInterface.

isInteractiveInput()

isInteractiveInput (   $inputStream )

private

Références QuestionHelper\$inputStream, $output, et null.

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

mostRecentlyEnteredValue()

mostRecentlyEnteredValue ( string  $entered )

private

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

readInput()

readInput (   $inputStream, Question  $question  )

private

Reads one or more lines of input and returns what is read.

Paramètres

resource	$inputStream	The handler resource
Question	$question	The question being asked

Renvoie

string|false The input received, false in case input could not be read

Références QuestionHelper\$inputStream, QuestionHelper\cloneInputStream(), Question\isMultiline(), null, QuestionHelper\resetIOCodepage(), et QuestionHelper\setIOCodepage().

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

resetIOCodepage()

resetIOCodepage ( int  $cp,   $input  )

private

Sets console I/O to the specified code page and converts the user input.

Paramètres

string | false

$input

Renvoie

string|false

Références $input.

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

setIOCodepage()

setIOCodepage ( )

private

Sets console I/O to the host code page.

Renvoie

int Previous code page in IBM/EBCDIC format

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

validateAttempts()

validateAttempts ( callable  $interviewer, OutputInterface  $output, Question  $question  )

private

Validates an attempt.

Paramètres

callable

$interviewer

A callable that will ask for a question and return the result

Renvoie

mixed The validated response

Exceptions

Références Question\getMaxAttempts(), Question\getValidator(), null, et QuestionHelper\writeError().

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

writeError()

writeError ( OutputInterface  $output, \Exception  $error  )

protected

Outputs an error message.

Références $message, $output, Helper\getHelperSet(), Symfony\Contracts\Service\has(), et null.

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

writePrompt()

writePrompt ( OutputInterface  $output, Question  $question  )

protected

Outputs the question prompt.

Références $message, $output, QuestionHelper\formatChoiceQuestionChoices(), et Question\getQuestion().

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

Documentation des champs

$inputStream

$inputStream

private

Référencé par QuestionHelper\autocomplete(), QuestionHelper\cloneInputStream(), QuestionHelper\doAsk(), QuestionHelper\getHiddenResponse(), QuestionHelper\isInteractiveInput(), et QuestionHelper\readInput().

$stdinIsInteractive

$stdinIsInteractive

staticprivate

$stty

$stty = true

staticprivate

---

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

• QuestionHelper.php