Skip to content

[Console] Document lazy command via description #15742

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.

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 24, 2021
Merged
Changes from all commits
Commits
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
13 changes: 11 additions & 2 deletions console.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,19 +79,28 @@ Configuring the Command
You can optionally define a description, help message and the
:doc:`input options and arguments </console/input>`::

// ...
// the short description shown while running "php bin/console list"
protected static $defaultDescription = 'Creates a new user.';

// ...
protected function configure(): void
{
$this
// the short description shown while running "php bin/console list"
->setDescription('Creates a new user.')
->setDescription(self::$defaultDescription)

// the full command description shown when running the command with
// the "--help" option
->setHelp('This command allows you to create a user...')
;
}

.. versionadded:: 5.3

The ``$defaultDescription`` static property was introduced in Symfony 5.3.
It allows to make the ``php bin/console list`` lazy.
You can as well use ``php bin/console list --short`` option to have the output faster.

The ``configure()`` method is called automatically at the end of the command
constructor. If your command defines its own constructor, set the properties
first and then call to the parent constructor, to make those properties
Expand Down