Skip to content
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

Jump to bottom

[Console] Command Lifecycle explications #5319

Closed
wants to merge 4 commits into from
Closed

[Console] Command Lifecycle explications #5319

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c78eaa5
[Console] Command Lifecycle explications
94noni May 26, 2015
3ca7c37
fix
94noni May 26, 2015
6abe3b1
fix style
94noni Jun 1, 2015
0faae4a
fix
94noni Jun 2, 2015
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
25 changes: 25 additions & 0 deletions components/console/introduction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,31 @@ This prints::

HELLO FABIEN

Command Lifecycle
~~~~~~~~~~~~~~~~~

Commands have three lifecycle methods:

:method:`Symfony\\Component\\Console\\Command\\Command::initialize`
This method is executed before the ``interact()`` and the ``execute()``
methods. It's main purpose is to initialize the variables used in the
rest of the command methods.

:method:`Symfony\\Component\\Console\\Command\\Command::interact`
This method is executed after ``initialize()`` and before ``execute()``.
Its purpose is to check if some of the options/arguments are missing
and interactively ask the user for those values. This is the last place
where you can ask for missing options/arguments otherwise the command
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need a separation here:

[...] options/arguments otherwise [...]

[...] options/arguments. Otherwise [...]

will throw an error.

:method:`Symfony\\Component\\Console\\Command\\Command::execute`
This method is executed after ``interact()`` and ``initialize()``.
It contains the logic you want the command executes.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

[...] the logic you want the command executes.

[...] the logic you want the command to execute.
(or)
[...] the logic you want to execute in the command.


Note that ``execute()`` is the only required method of the three.

The ``initialize()`` and ``interact()`` methods are completely optional.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can merge this phrase with the previous one.


.. _components-console-coloring:

Coloring the Output
Expand Down