Skip to content

Commit 28d51a9

Browse files
committed
Merge pull request #2642 from mpartel/progresshelper-clear
[WCM] Documented ProgressHelper's clear() method.
2 parents d7da8a5 + ac3df57 commit 28d51a9

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

components/console/helpers/progresshelper.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ Progress Helper
1010
.. versionadded:: 2.3
1111
The ``setCurrent`` method was added in Symfony 2.3.
1212

13+
.. versionadded:: 2.4
14+
The ``clear`` method was added in Symfony 2.4.
15+
1316
When executing longer-running commands, it may be helpful to show progress
1417
information, which updates as your command runs:
1518

@@ -37,6 +40,12 @@ pass it a total number of units, and advance the progress as your command execut
3740
:method:`Symfony\\Component\\Console\\Helper\\ProgressHelper::setCurrent`
3841
method.
3942

43+
If you want to output something while the progress bar is running,
44+
call :method:`Symfony\\Component\\Console\\Helper\\ProgressHelper::clear` first.
45+
After you're done, call
46+
:method:`Symfony\\Component\\Console\\Helper\\ProgressHelper::display`
47+
to show the progress bar again.
48+
4049
The appearance of the progress output can be customized as well, with a number
4150
of different levels of verbosity. Each of these displays different possible
4251
items - like percentage completion, a moving progress bar, or current/total

0 commit comments

Comments
 (0)