Skip to content

[Console] Update FinishedIndicator documentation for Progress indicator #20331

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
Oct 16, 2024
Merged

[Console] Update FinishedIndicator documentation for Progress indicator #20331

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
24 changes: 14 additions & 10 deletions components/console/helpers/progressindicator.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,18 +44,21 @@ level of verbosity of the ``OutputInterface`` instance:
| Processing...
/ Processing...
- Processing...
✔ Finished

# OutputInterface::VERBOSITY_VERBOSE (-v)
\ Processing... (1 sec)
| Processing... (1 sec)
/ Processing... (1 sec)
- Processing... (1 sec)
✔ Finished (1 sec)

# OutputInterface::VERBOSITY_VERY_VERBOSE (-vv) and OutputInterface::VERBOSITY_DEBUG (-vvv)
\ Processing... (1 sec, 6.0 MiB)
| Processing... (1 sec, 6.0 MiB)
/ Processing... (1 sec, 6.0 MiB)
- Processing... (1 sec, 6.0 MiB)
✔ Finished (1 sec, 6.0 MiB)

.. tip::

Expand Down Expand Up @@ -94,22 +97,23 @@ The progress indicator will now look like this:
⠛ Processing...
⠹ Processing...
⢸ Processing...
✔ Finished

Once the progress indicator is finished, it keeps the latest indicator value by
default. You can replace it with your own::
Once the progress indicator is finished, it uses the finishedIndicator value (which defaults to ✔). You can replace it with your own::

$progressIndicator->finish('Finished', '✅');

Then the progress indicator will render like this:

.. code-block:: text
$progressIndicator = new ProgressIndicator($output, 'verbose', 100, null, '🎉');

try {
/* do something */
$progressIndicator->finish('Finished');
} catch (\Exception) {
$progressIndicator->finish('Failed', '🚨');
}

⠏ Processing...
⠛ Processing...
✅ Finished

.. versionadded:: 7.2

The ``finishedIndicator`` parameter for the constructor was introduced in Symfony 7.2.
The ``finishedIndicator`` parameter for method ``finish()`` was introduced in Symfony 7.2.

Customize Placeholders
Expand Down
Loading