Skip to content

[WCM] Documented ProgressHelper's clear() method. #2642

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
Jun 30, 2013
Merged

[WCM] Documented ProgressHelper's clear() method. #2642

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
9 changes: 9 additions & 0 deletions components/console/helpers/progresshelper.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Progress Helper
.. versionadded:: 2.3
The ``setCurrent`` method was added in Symfony 2.3.

.. versionadded:: 2.4
The ``clear`` method was added in Symfony 2.4.

When executing longer-running commands, it may be helpful to show progress
information, which updates as your command runs:

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

If you want to output something while the progress bar is running,
call :method:`Symfony\\Component\\Console\\Helper\\ProgressHelper::clear` first.
After you're done, call
:method:`Symfony\\Component\\Console\\Helper\\ProgressHelper::display`
to show the progress bar again.

The appearance of the progress output can be customized as well, with a number
of different levels of verbosity. Each of these displays different possible
items - like percentage completion, a moving progress bar, or current/total
Expand Down