Documentation

QuestionHelper extends Helper
in package

The QuestionHelper class provides helpers to interact with the user.

Tags
author

Fabien Potencier fabien@symfony.com

Table of Contents

Properties

$helperSet  : mixed
$inputStream  : resource|null
$stdinIsInteractive  : bool
$stty  : bool

Methods

ask()  : mixed
Asks a question to the user.
disableStty()  : void
Prevents usage of stty.
formatMemory()  : string
formatTime()  : string
getHelperSet()  : HelperSet|null
Gets the helper set associated with this helper.
getName()  : string
Returns the canonical name of this helper.
length()  : int
Returns the length of a string, using mb_strlen if it is available.
removeDecoration()  : string
setHelperSet()  : void
Sets the helper set associated with this helper.
substr()  : string
Returns the subset of a string, using mb_substr if it is available.
width()  : int
Returns the width of a string, using mb_strwidth if it is available.
formatChoiceQuestionChoices()  : array<string|int, string>
writeError()  : void
Outputs an error message.
writePrompt()  : void
Outputs the question prompt.
autocomplete()  : string
Autocompletes a question.
cloneInputStream()  : resource|null
Clones an input stream in order to act on one instance of the same stream without affecting the other instance.
doAsk()  : mixed
Asks the question to the user.
getDefaultAnswer()  : mixed
getHiddenResponse()  : string
Gets a hidden response from user.
isInteractiveInput()  : bool
mostRecentlyEnteredValue()  : string
readInput()  : string|false
Reads one or more lines of input and returns what is read.
resetIOCodepage()  : string|false
Sets console I/O to the specified code page and converts the user input.
setIOCodepage()  : int
validateAttempts()  : mixed
Validates an attempt.

Properties

$helperSet

protected mixed $helperSet

Methods

disableStty()

Prevents usage of stty.

public static disableStty() : void

formatMemory()

public static formatMemory(int $memory) : string
Parameters
$memory : int
Return values
string

formatTime()

public static formatTime(int|float $secs[, int $precision = 1 ]) : string
Parameters
$secs : int|float
$precision : int = 1
Return values
string

getHelperSet()

Gets the helper set associated with this helper.

public getHelperSet() : HelperSet|null
Return values
HelperSet|null

getName()

Returns the canonical name of this helper.

public getName() : string
Return values
string

length()

Returns the length of a string, using mb_strlen if it is available.

public static length(string|null $string) : int

The length is related to how many bytes the string will use.

Parameters
$string : string|null
Return values
int

setHelperSet()

Sets the helper set associated with this helper.

public setHelperSet([HelperSet|null $helperSet = null ]) : void
Parameters
$helperSet : HelperSet|null = null

substr()

Returns the subset of a string, using mb_substr if it is available.

public static substr(string|null $string, int $from[, int|null $length = null ]) : string
Parameters
$string : string|null
$from : int
$length : int|null = null
Return values
string

width()

Returns the width of a string, using mb_strwidth if it is available.

public static width(string|null $string) : int

The width is how many characters positions the string will use.

Parameters
$string : string|null
Return values
int

formatChoiceQuestionChoices()

protected formatChoiceQuestionChoices(ChoiceQuestion $question, string $tag) : array<string|int, string>
Parameters
$question : ChoiceQuestion
$tag : string
Return values
array<string|int, string>

autocomplete()

Autocompletes a question.

private autocomplete(OutputInterface $output, Question $question, resource $inputStream, callable $autocomplete) : string
Parameters
$output : OutputInterface
$question : Question
$inputStream : resource
$autocomplete : callable
Return values
string

cloneInputStream()

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

private cloneInputStream(resource $inputStream) : resource|null
Parameters
$inputStream : resource

The handler resource

Return values
resource|null —

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

getHiddenResponse()

Gets a hidden response from user.

private getHiddenResponse(OutputInterface $output, resource $inputStream[, bool $trimmable = true ]) : string
Parameters
$output : OutputInterface
$inputStream : resource

The handler resource

$trimmable : bool = true

Is the answer trimmable

Tags
throws
RuntimeException

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

Return values
string

isInteractiveInput()

private isInteractiveInput(mixed $inputStream) : bool
Parameters
$inputStream : mixed
Return values
bool

mostRecentlyEnteredValue()

private mostRecentlyEnteredValue(string $entered) : string
Parameters
$entered : string
Return values
string

readInput()

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

private readInput(resource $inputStream, Question $question) : string|false
Parameters
$inputStream : resource

The handler resource

$question : Question

The question being asked

Return values
string|false

resetIOCodepage()

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

private resetIOCodepage(int $cp, string|false $input) : string|false
Parameters
$cp : int
$input : string|false
Return values
string|false

setIOCodepage()

private setIOCodepage() : int
Return values
int

validateAttempts()

Validates an attempt.

private validateAttempts(callable $interviewer, OutputInterface $output, Question $question) : mixed
Parameters
$interviewer : callable

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

$output : OutputInterface
$question : Question
Tags
throws
Exception

In case the max number of attempts has been reached and no valid response has been given


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results