1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. Console
  7. \
  8. Helper
  9. \
  10. QuestionHelper

QuestionHelper

class QuestionHelper extends Helper

The QuestionHelper class provides helpers to interact with the user.

Properties

protected $helperSet from Helper

Methods

setHelperSet(HelperSet $helperSet = null)

Sets the helper set associated with this helper.

from Helper
HelperSet
getHelperSet()

Gets the helper set associated with this helper.

from Helper
static int
strlen(string $string)

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

from Helper
static string
substr(string $string, int $from, int|null $length = null)

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

from Helper
static 
formatTime($secs)

No description

from Helper
static 
formatMemory($memory)

No description

from Helper
static 
strlenWithoutDecoration(OutputFormatterInterface $formatter, $string)

No description

from Helper
static 
removeDecoration(OutputFormatterInterface $formatter, $string)

No description

from Helper
mixed
ask(InputInterface $input, OutputInterface $output, Question $question)

Asks a question to the user.

string
getName()

Returns the canonical name of this helper.

static 
disableStty()

Prevents usage of stty.

writePrompt(OutputInterface $output, Question $question)

Outputs the question prompt.

writeError(OutputInterface $output, Exception $error)

Outputs an error message.

Details

setHelperSet(HelperSet $helperSet = null)

Sets the helper set associated with this helper.

Parameters

HelperSet $helperSet

HelperSet getHelperSet()

Gets the helper set associated with this helper.

Return Value

HelperSet A HelperSet instance

static int strlen(string $string)

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

Parameters

string $string The string to check its length

Return Value

int The length of the string

static string substr(string $string, int $from, int|null $length = null)

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

Parameters

string $string String to subset
int $from Start offset
int|null $length Length to read

Return Value

string The string subset

static formatTime($secs)

Parameters

$secs

static formatMemory($memory)

Parameters

$memory

static strlenWithoutDecoration(OutputFormatterInterface $formatter, $string)

Parameters

OutputFormatterInterface $formatter
$string

static removeDecoration(OutputFormatterInterface $formatter, $string)

Parameters

OutputFormatterInterface $formatter
$string

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

Asks a question to the user.

Parameters

InputInterface $input
OutputInterface $output
Question $question

Return Value

mixed The user answer

Exceptions

RuntimeException If there is no data to read in the input stream

string getName()

Returns the canonical name of this helper.

Return Value

string The canonical name

static disableStty()

Prevents usage of stty.

protected writePrompt(OutputInterface $output, Question $question)

Outputs the question prompt.

Parameters

OutputInterface $output
Question $question

protected writeError(OutputInterface $output, Exception $error)

Outputs an error message.

Parameters

OutputInterface $output
Exception $error