554b28d975
This PR was merged into the 2.5-dev branch. Discussion ---------- [Console] A better progress bar | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #9573, #9574, #10187, #9951, related to #9788 | License | MIT | Doc PR | symfony/symfony-docs#3626 TODO: - [x] add some docs See what this PR allows you to do easily:  ## New ProgressBar class First, this PR deprecates `ProgressHelper` in favor of `ProgressBar`. The main difference is that the new `ProgressBar` class represents a single progress bar, which allows for more than one bar to be displayed at a time: ```php 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:  ## Format Placeholders This pull request refactors the way placeholders in the progress bar are managed. It is now possible to add new placeholders or replace existing ones: ```php // set a new placeholder ProgressBar::setPlaceholderFormatterDefinition('remaining_steps', function (ProgressBar $bar) { return $bar->getMaxSteps() - $bar->getStep(); }); // change the behavior of an existing placeholder ProgressBar::setPlaceholderFormatterDefinition('max', function (ProgressBar $bar) { return $bar->getMaxSteps() ?: '~'; }); ``` Several new built-in placeholders have also been added: * `%remaining%`: Display the remaining time * `%estimated%`: Display the estimated time of the whole "task" * `%memory%`: Display the memory usage ## Formats Formats can also be added (or built-in ones modified): ```php ProgressBar::setFormatDefinition('simple', '%current%'); $bar->setFormat('simple'); // is equivalent to $bar->setFormat('%current%'); ``` Built-in formats are: * `quiet` * `normal` * `verbose` * `quiet_nomax` * `normal_nomax` * `verbose_nomax` ## Format Messages You can also set arbitrary messages that depends on the progression in the progress bar: ```php $bar = new ProgressBar($output, 10); $bar->setFormat("%message% %current%/%max% [%bar%]"); $bar->setMessage('started'); $bar->start(); $bar->setMessage('advancing'); $bar->advance(); $bar->setMessage('finish'); $bar->finish(); ``` You are not limited to a single message (`message` being just the default one): ```php $bar = new ProgressBar($output, 10); $bar->setFormat("%message% %current%/%max% [%bar%] %end%"); $bar->setMessage('started'); $bar->setMessage('', 'end'); $bar->start(); $bar->setMessage('advancing'); $bar->advance(); $bar->setMessage('finish'); $bar->setMessage('ended...', 'end'); $bar->finish(); ``` ## Multiline Formats A progress bar can now span more than one line: ```php $bar->setFormat("%current%/%max% [%bar%]\n%message%"); ``` ## Flexible Format Definitions The hardcoded formatting for some placeholders (like `%percent%` or `%elapsed%`) have been removed in favor of a `sprintf`-like format: ```php $bar->setFormat("%current%/%max% [%bar%] %percent:3s%"); ``` Notice the `%percent:3s%` placeholder. Here, `%3s` is going to be used when rendering the placeholder. ## ANSI colors and Emojis The new progress bar output can now contain ANSI colors and.or Emojis (see the small video at the top of this PR). Commits ------- |
||
|---|---|---|
| src/Symfony | ||
| .editorconfig | ||
| .gitignore | ||
| .travis.yml | ||
| autoload.php.dist | ||
| CHANGELOG-2.2.md | ||
| CHANGELOG-2.3.md | ||
| CHANGELOG-2.4.md | ||
| composer.json | ||
| CONTRIBUTING.md | ||
| CONTRIBUTORS.md | ||
| LICENSE | ||
| phpunit.xml.dist | ||
| README.md | ||
| UPGRADE-2.1.md | ||
| UPGRADE-2.2.md | ||
| UPGRADE-2.3.md | ||
| UPGRADE-2.4.md | ||
| UPGRADE-2.5.md | ||
| UPGRADE-3.0.md | ||
README
What is Symfony2?
Symfony2 is a PHP 5.3 full-stack web framework. It is written with speed and flexibility in mind. It allows developers to build better and easy to maintain websites with PHP.
Symfony can be used to develop all kind of websites, from your personal blog to high traffic ones like Dailymotion or Yahoo! Answers.
Requirements
Symfony2 is only supported on PHP 5.3.3 and up.
Be warned that PHP versions before 5.3.8 are known to be buggy and might not work for you:
-
before PHP 5.3.4, if you get "Notice: Trying to get property of non-object", you've hit a known PHP bug (see https://bugs.php.net/bug.php?id=52083 and https://bugs.php.net/bug.php?id=50027);
-
before PHP 5.3.8, if you get an error involving annotations, you've hit a known PHP bug (see https://bugs.php.net/bug.php?id=55156).
-
PHP 5.3.16 has a major bug in the Reflection subsystem and is not suitable to run Symfony2 (https://bugs.php.net/bug.php?id=62715)
Installation
The best way to install Symfony2 is to download the Symfony Standard Edition available at http://symfony.com/download.
Documentation
The "Quick Tour" tutorial gives you a first feeling of the framework. If, like us, you think that Symfony2 can help speed up your development and take the quality of your work to the next level, read the official Symfony2 documentation.
Contributing
Symfony2 is an open source, community-driven project. If you'd like to contribute, please read the Contributing Code part of the documentation. If you're submitting a pull request, please follow the guidelines in the Submitting a Patch section and use Pull Request Template.
Running Symfony2 Tests
Information on how to run the Symfony2 test suite can be found in the Running Symfony2 Tests section.