Skip to content

[Console] added ProgressBar (to replace the stateful ProgressHelper class)#10355

Closed
fabpot wants to merge 1 commit intosymfony:masterfrom
fabpot:progress-helper-stateless
Closed

[Console] added ProgressBar (to replace the stateful ProgressHelper class)#10355
fabpot wants to merge 1 commit intosymfony:masterfrom
fabpot:progress-helper-stateless

Conversation

@fabpot
Copy link
Copy Markdown
Member

@fabpot fabpot commented Mar 1, 2014

Q A
Bug fix? no
New feature? yes
BC breaks? no
Deprecations? yes
Tests pass? yes
Fixed tickets #9951, related to #9788
License MIT
Doc PR n/a

TODO:

  • submit a PR on the docs

This PR deprecated ProgressHelper in favor of ProgressBar. The main difference is that the new ProgressBar class is stateless, which allows for more than one bar to be displayed at a time:

use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Output\ConsoleOutput;

$output = new ConsoleOutput();

$bar1 = new ProgressBar($output, 10);
$bar2 = new ProgressBar($output, 20);
$bar2->setProgressCharacter('#');
$bar1->start();
print "\n";
$bar2->start();

for ($i = 1; $i <= 20; $i++) {
    // up one line
    $output->write("\033[1A");
    usleep(100000);
    if ($i <= 10) {
        $bar1->advance();
    }
    print "\n";
    $bar2->advance();
}

And here is how it looks like when run:

progress-bars

@fabpot
Copy link
Copy Markdown
Member Author

fabpot commented Mar 1, 2014

By the way, that also makes the progress bar part of the Console more easily reusable outside the context of a full console app/command.

@wouterj
Copy link
Copy Markdown
Member

wouterj commented Mar 1, 2014

Wouldn't it be nicer if there was a ProgressGroup or the like? There we can specify multiple progress bars and tell if it shoúld be placed horizontal or vertical. It would also handle the "moved one line up" things

cordoval
cordoval reviewed Mar 1, 2014
View reviewed changes
src/Symfony/Component/Console/Helper/ProgressBar.php
Copy link
Copy Markdown
Contributor

@cordoval cordoval Mar 1, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

integer for consistency

@cordoval cordoval mentioned this pull request Mar 1, 2014
Merged
1 task
@fabpot
Copy link
Copy Markdown
Member Author

fabpot commented Mar 1, 2014

I don't think it would make sense to create a ProgressGroup as it won't bring much to the table (and would restrict what you could do).

@fabpot
Copy link
Copy Markdown
Member Author

fabpot commented Mar 1, 2014

Closing for #10356 instead.

@fabpot fabpot closed this Mar 1, 2014
@fabpot fabpot deleted the progress-helper-stateless branch March 1, 2014 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@fabpot @wouterj @cordoval