[ Index ]

PHP Cross Reference of phpBB-3.2.8-deutsch

title

Body

[close]

/vendor/symfony/console/Helper/ -> QuestionHelper.php (summary)

(no description)

File Size: 456 lines (14 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

QuestionHelper:: (12 methods):
  ask()
  setInputStream()
  getInputStream()
  getName()
  doAsk()
  writePrompt()
  writeError()
  autocomplete()
  getHiddenResponse()
  validateAttempts()
  getShell()
  hasSttyAvailable()


Class: QuestionHelper  - X-Ref

The QuestionHelper class provides helpers to interact with the user.

ask(InputInterface $input, OutputInterface $output, Question $question)   X-Ref
Asks a question to the user.

return: mixed The user answer

setInputStream($stream)   X-Ref
Sets the input stream to read from when interacting with the user.

This is mainly useful for testing purpose.

param: resource $stream The input stream

getInputStream()   X-Ref
Returns the helper's input stream.

return: resource

getName()   X-Ref
{@inheritdoc}


doAsk(OutputInterface $output, Question $question)   X-Ref
Asks the question to the user.

This method is public for PHP 5.3 compatibility, it should be private.

return: bool|mixed|string|null

writePrompt(OutputInterface $output, Question $question)   X-Ref
Outputs the question prompt.


writeError(OutputInterface $output, \Exception $error)   X-Ref
Outputs an error message.


autocomplete(OutputInterface $output, Question $question, $inputStream, array $autocomplete)   X-Ref
Autocompletes a question.

param: OutputInterface $output
param: Question        $question
param: resource        $inputStream
param: array           $autocomplete
return: string

getHiddenResponse(OutputInterface $output, $inputStream)   X-Ref
Gets a hidden response from user.

param: OutputInterface $output      An Output instance
param: resource        $inputStream The handler resource
return: string The answer

validateAttempts($interviewer, OutputInterface $output, Question $question)   X-Ref
Validates an attempt.

param: callable        $interviewer A callable that will ask for a question and return the result
param: OutputInterface $output      An Output instance
param: Question        $question    A Question instance
return: mixed The validated response

getShell()   X-Ref
Returns a valid unix shell.

return: string|bool The valid shell name, false in case no valid shell is found

hasSttyAvailable()   X-Ref
Returns whether Stty is available or not.

return: bool



Generated: Tue Apr 7 19:42:26 2020 Cross-referenced by PHPXref 0.7.1