Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[Console] Add documentation for the ProgressBar::iterate method #10949

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 1, 2019
Merged

[Console] Add documentation for the ProgressBar::iterate method #10949

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions components/console/helpers/progressbar.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,23 @@ that the progress bar display is refreshed with a 100% completion.
:method:`Symfony\\Component\\Console\\Helper\\ProgressBar::display`
to show the progress bar again.

If you want to use the progress bar to show the progress of an iteration you can use the
:method:`Symfony\\Component\\Console\\Helper\\ProgressBar::iterate` method that will automatically call ``start``,
``advance`` and ``finish`` while iterating::

use Symfony\Component\Console\Helper\ProgressBar;

$progressBar = new ProgressBar($output);

// starts and displays the progress bar
foreach ($progressBar->iterate($iterable) as $key => $value) {
// ... do some work
}

.. versionadded:: 4.3

The ``iterate`` method was introduced in Symfony 4.3.

Customizing the Progress Bar
----------------------------

Expand Down