[Console] Document timeout functionality for QuestionHelper
#21369
+57
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
OskarStark
reviewed
Sep 12, 2025
| Setting a Timeout for User Input | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| .. versionadded:: 7.4 |
There was a problem hiding this comment.
let move this at the end of this section please
OskarStark
reviewed
Sep 12, 2025
| $helper = new QuestionHelper(); | ||
|
|
||
| $question = new Question('Please enter your answer'); | ||
| $question->setTimeout(30); // 30 seconds timeout |
There was a problem hiding this comment.
Suggested change
| $question->setTimeout(30); // 30 seconds timeout | |
| $question->setTimeout(seconds: 30); |
would be much better, but lets wait for @xabbuh and @javiereguiluz, because IIRC we don't use named arguments in the docs, as they are not covered by BC
There was a problem hiding this comment.
I know and I agree. But, it was decided to never show named arguments in docs, so let's not do this. Thanks.
OskarStark
reviewed
Sep 12, 2025
|
|
||
| // ... | ||
| $question = new ConfirmationQuestion('Do you want to continue?', false); | ||
| $question->setTimeout(10); // 10 seconds timeout |
There was a problem hiding this comment.
Suggested change
| $question->setTimeout(10); // 10 seconds timeout | |
| $question->setTimeout(seconds: 10); |
See comment above
OskarStark
changed the title
QuestionHelper
javiereguiluz
added
Status: Reviewed
and removed
Status: Needs Work
Status: Needs Review
labels
javiereguiluz
force-pushed
the
console-question-timeout
branch
from
b6a3f86 to
c6d70aa
Compare
|
Thanks Jan for this nice contribution and for adding the docs for it too. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds documentation for the setTimeout() method that was added to the Question class in Symfony 7.4. The timeout feature allows setting a maximum time limit for user input to prevent hanging indefinitely in interactive questions, particularly useful in database transactions or other time-sensitive operations.
Closes #21366