| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 615 lines (20 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
QuestionHelper:: (17 methods):
ask()
getName()
disableStty()
doAsk()
getDefaultAnswer()
writePrompt()
formatChoiceQuestionChoices()
writeError()
autocomplete()
mostRecentlyEnteredValue()
getHiddenResponse()
validateAttempts()
isInteractiveInput()
readInput()
setIOCodepage()
resetIOCodepage()
cloneInputStream()
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 |
| getName() X-Ref |
| {@inheritdoc} |
| disableStty() X-Ref |
| Prevents usage of stty. |
| doAsk(OutputInterface $output, Question $question) X-Ref |
| Asks the question to the user. return: mixed |
| getDefaultAnswer(Question $question) X-Ref |
return: mixed |
| writePrompt(OutputInterface $output, Question $question) X-Ref |
| Outputs the question prompt. |
| formatChoiceQuestionChoices(ChoiceQuestion $question, string $tag) X-Ref |
return: string[] |
| writeError(OutputInterface $output, \Exception $error) X-Ref |
| Outputs an error message. |
| autocomplete(OutputInterface $output, Question $question, $inputStream, callable $autocomplete) X-Ref |
| Autocompletes a question. param: resource $inputStream |
| mostRecentlyEnteredValue(string $entered) X-Ref |
| No description |
| getHiddenResponse(OutputInterface $output, $inputStream, bool $trimmable = true) X-Ref |
| Gets a hidden response from user. param: resource $inputStream The handler resource param: bool $trimmable Is the answer trimmable |
| validateAttempts(callable $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 return: mixed The validated response |
| isInteractiveInput($inputStream) X-Ref |
| No description |
| readInput($inputStream, Question $question) X-Ref |
| Reads one or more lines of input and returns what is read. param: resource $inputStream The handler resource param: Question $question The question being asked return: string|false The input received, false in case input could not be read |
| setIOCodepage() X-Ref |
| Sets console I/O to the host code page. return: int Previous code page in IBM/EBCDIC format |
| resetIOCodepage(int $cp, $input) X-Ref |
| Sets console I/O to the specified code page and converts the user input. param: string|false $input return: string|false |
| cloneInputStream($inputStream) X-Ref |
| Clones an input stream in order to act on one instance of the same stream without affecting the other instance. param: resource $inputStream The handler resource return: resource|null The cloned resource, null in case it could not be cloned |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |