[Console] add overwrite flag to ProgressBar helper to allow non-decorated output #11852
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
|
it would be good to add a test using |
|
Done, good catch. |
| * | ||
| * @param bool $overwrite | ||
| */ | ||
| public function setOverwrite($overwrite = true) |
There was a problem hiding this comment.
I would not provide a default value for the argument.
This was referenced Sep 5, 2014
|
btw, the windows cmd shell supports the overwriting sequence, while it does not support colors (it requires wrapping it in ConEmu or Ansicon to get color support). would it make sense to tweak a bit the default value of |
|
hmm, what would we do if someone used the |
|
Anything preventing this from making it into 2.6? |
|
👍 |
|
Thank you @kbond. |
fabpot
added a commit
that referenced
this pull request
Sep 22, 2014
…allow non-decorated output (kbond) This PR was merged into the 2.6-dev branch. Discussion ---------- [Console] add overwrite flag to ProgressBar helper to allow non-decorated output | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | yes, but not critical | Deprecations? | no | Tests pass? | yes | Fixed tickets | #11542, #10011 | License | MIT | Doc PR | symfony/symfony-docs#4206 By default, the `ProgressBar` helper overwrites the output to give the nice progress bar look. To prevent the output from blowing up in non-decorated environments, the output was hidden in these environments (see #9846). This PR enables using the `ProgressBar` in non-decorated environments by adding an `overwrite` flag. When `false`, instead of overwriting the bar, it is rendered on a new line. To prevent flooding the output, you can adjust the `redrawFrequency`. By default, when using the `ProgressBar` in a non-decorated environment, the `overwrite` flag is set to false. If a `max` is set, the `redrawFrequency` is set to a sensible default (10% of the max). If a `max` isn't set, the bar is output for every advance so to prevent flooding, a sensible `redrawFrequency` should be manually set. The only BC break is that output will now display where it didn't before. Commits ------- cdee6f6 add overwrite flag to allow non-decorated output
weaverryan
added a commit
to symfony/symfony-docs
that referenced
this pull request
Oct 3, 2014
This PR was merged into the master branch. Discussion ---------- Added note about ProgressBar changes | Q | A | ------------- | --- | Doc fix? | no | New docs? | symfony/symfony#11852 | Applies to | 2.6 | Fixed tickets | n/a Commits ------- 4e2142d Added note about ProgressBar changes
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.
By default, the
ProgressBarhelper overwrites the output to give the nice progress bar look. To prevent the output from blowing up in non-decorated environments, the output was hidden in these environments (see #9846).This PR enables using the
ProgressBarin non-decorated environments by adding anoverwriteflag. Whenfalse, instead of overwriting the bar, it is rendered on a new line. To prevent flooding the output, you can adjust theredrawFrequency.By default, when using the
ProgressBarin a non-decorated environment, theoverwriteflag is set to false. If amaxis set, theredrawFrequencyis set to a sensible default (10% of the max). If amaxisn't set, the bar is output for every advance so to prevent flooding, a sensibleredrawFrequencyshould be manually set.The only BC break is that output will now display where it didn't before.