Skip to content

[Console] Improve console events doc #18741

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
Aug 28, 2023
Merged

[Console] Improve console events doc #18741

Show file tree
Hide file tree
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
7 changes: 4 additions & 3 deletions components/console/events.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ the wheel, it uses the Symfony EventDispatcher component to do the work::
.. caution::

Console events are only triggered by the main command being executed.
Commands called by the main command will not trigger any event.
Commands called by the main command will not trigger any event, unless
run by the application itself, see :doc:`/console/calling_commands`.

The ``ConsoleEvents::COMMAND`` Event
------------------------------------
Expand Down Expand Up @@ -171,10 +172,10 @@ Listeners receive a
use Symfony\Component\Console\Event\ConsoleSignalEvent;

$dispatcher->addListener(ConsoleEvents::SIGNAL, function (ConsoleSignalEvent $event) {

// gets the signal number
$signal = $event->getHandlingSignal();

if (\SIGINT === $signal) {
echo "bye bye!";
}
Expand Down
6 changes: 6 additions & 0 deletions console.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -574,6 +574,12 @@ registers an :doc:`event subscriber </event_dispatcher>` to listen to the
:ref:`ConsoleEvents::TERMINATE event <console-events-terminate>` and adds a log
message whenever a command doesn't finish with the ``0`` `exit status`_.

Using Events And Handling Signals
---------------------------------

When a command is running, many events are dispatched, one of them allows to
react to signals, read more in :doc:`this section </components/console/events>`.

Learn More
----------

Expand Down
34 changes: 21 additions & 13 deletions console/calling_commands.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ or if you want to create a "meta" command that runs a bunch of other commands
changed on the production servers: clearing the cache, generating Doctrine
proxies, dumping web assets, ...).

Use the :method:`Symfony\\Component\\Console\\Application::find` method to
find the command you want to run by passing the command name. Then, create a
new :class:`Symfony\\Component\\Console\\Input\\ArrayInput` with the
arguments and options you want to pass to the command.
Use the :method:`Symfony\\Component\\Console\\Application::doRun`. Then, create
a new :class:`Symfony\\Component\\Console\\Input\\ArrayInput` with the
arguments and options you want to pass to the command. The command name must be
the first argument.

Eventually, calling the ``run()`` method actually runs the command and returns
the returned code from the command (return value from command's ``execute()``
Eventually, calling the ``doRun()`` method actually runs the command and returns
the returned code from the command (return value from command ``execute()``
method)::

// ...
Expand All @@ -29,15 +29,14 @@ method)::

protected function execute(InputInterface $input, OutputInterface $output): int
{
$command = $this->getApplication()->find('demo:greet');

$arguments = [
$greetInput = new ArrayInput([
// the command name is passed as first argument
'command' => 'demo:greet',
'name' => 'Fabien',
'--yell' => true,
];
]);

$greetInput = new ArrayInput($arguments);
$returnCode = $command->run($greetInput, $output);
$returnCode = $this->getApplication()->doRun($greetInput, $output);

// ...
}
Expand All @@ -47,7 +46,16 @@ method)::

If you want to suppress the output of the executed command, pass a
:class:`Symfony\\Component\\Console\\Output\\NullOutput` as the second
argument to ``$command->run()``.
argument to ``$application->doRun()``.

.. note::

Using ``doRun()`` instead of ``run()`` prevents autoexiting and allows to
return the exit code instead.

Also, using ``$this->getApplication()->doRun()`` instead of
``$this->getApplication()->find('demo:greet')->run()`` will allow proper
events to be dispatched for that inner command as well.

.. caution::

Expand Down