File tree Expand file tree Collapse file tree 1 file changed +17
-0
lines changed
components/console/helpers Expand file tree Collapse file tree 1 file changed +17
-0
lines changed Original file line number Diff line number Diff line change @@ -95,6 +95,23 @@ that the progress bar display is refreshed with a 100% completion.
9595 :method: `Symfony\\ Component\\ Console\\ Helper\\ ProgressBar::display `
9696 to show the progress bar again.
9797
98+ If you want to use the progress bar to show the progress of an iteration you can use the
99+ :method: `Symfony\\ Component\\ Console\\ Helper\\ ProgressBar::iterate ` method that will automatically call ``start ``,
100+ ``advance `` and ``finish `` while iterating::
101+
102+ use Symfony\Component\Console\Helper\ProgressBar;
103+
104+ $progressBar = new ProgressBar($output);
105+
106+ // starts and displays the progress bar
107+ foreach ($progressBar->iterate($iterable) as $key => $value) {
108+ // ... do some work
109+ }
110+
111+ .. versionadded :: 4.3
112+
113+ The ``iterate `` method was introduced in Symfony 4.3.
114+
98115Customizing the Progress Bar
99116----------------------------
100117
You can’t perform that action at this time.
0 commit comments