Skip to content

[Console] Documented the info() method #14227

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
Sep 14, 2020
Merged

[Console] Documented the info() method #14227

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
21 changes: 21 additions & 0 deletions console/style.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,27 @@ Result Methods
'Consectetur adipiscing elit',
]);

:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::info`
It's similar to the ``success()`` method (the given string or array of strings
are displayed with a green background) but the ``[OK]`` label is not prefixed.
It's meant to be used once to display the final result of executing the given
command, without showing the result as a successful or failed one::

// use simple strings for short success messages
$io->info('Lorem ipsum dolor sit amet');

// ...

// consider using arrays when displaying long success messages
$io->info([
'Lorem ipsum dolor sit amet',
'Consectetur adipiscing elit',
]);

.. versionadded:: 5.2

The ``info()`` method was introduced in Symfony 5.2.

:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::warning`
It displays the given string or array of strings highlighted as a warning
message (with a red background and the ``[WARNING]`` label). It's meant to be
Expand Down