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

fabpot · 2014-03-01T04:52:27Z

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:

fabpot · 2014-03-01T05:23:02Z

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.

…lass)

wouterj · 2014-03-01T08:36:30Z

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 · 2014-03-01T11:50:28Z

src/Symfony/Component/Console/Helper/ProgressBar.php

+    /**
+     * Sets the progress bar width.
+     *
+     * @param int $size The progress bar size


integer for consistency

fabpot · 2014-03-01T17:14:19Z

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 · 2014-03-01T17:30:05Z

Closing for #10356 instead.

[Console] added ProgressBar (to replace the stateful ProgressHelper c…

4e76aa3

…lass)

cordoval reviewed Mar 1, 2014
View reviewed changes

cordoval mentioned this pull request Mar 1, 2014

[Console] A better progress bar #10356

Merged

1 task

fabpot closed this Mar 1, 2014

fabpot deleted the progress-helper-stateless branch March 1, 2014 17:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

fabpot commented Mar 1, 2014

fabpot commented Mar 1, 2014

wouterj commented Mar 1, 2014

cordoval Mar 1, 2014

fabpot commented Mar 1, 2014

fabpot commented Mar 1, 2014

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

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

Conversation

fabpot commented Mar 1, 2014

fabpot commented Mar 1, 2014

wouterj commented Mar 1, 2014

cordoval Mar 1, 2014

Choose a reason for hiding this comment

fabpot commented Mar 1, 2014

fabpot commented Mar 1, 2014