Using Events

The Application class of the Console component allows you to optionally hook into the lifecycle of a console application via events. Instead of reinventing the wheel, it uses the Symfony EventDispatcher component to do the work:

Console コンポーネントの Application クラスを使用すると、オプションで、イベントを介してコンソール アプリケーションのライフサイクルに接続できます。車輪を再発明する代わりに、Symfony EventDispatcher コンポーネントを使用して作業を行います。
1
2
3
4
5
6
7
8
 
use Symfony\Component\Console\Application;
use Symfony\Component\EventDispatcher\EventDispatcher;

$dispatcher = new EventDispatcher();

$application = new Application();
$application->setDispatcher($dispatcher);
$application->run();

Caution

注意

Console events are only triggered by the main command being executed. Commands called by the main command will not trigger any event.

コンソール イベントは、実行中のメイン コマンドによってのみトリガーされます。メイン コマンドによって呼び出されたコマンドは、イベントをトリガーしません。

The ConsoleEvents::COMMAND Event

Typical Purposes: Doing something before any command is run (like logging which command is going to be executed), or displaying something about the event to be executed.

典型的な目的: コマンドを実行する前に何かを行う (どのコマンドが実行されるかをログに記録するなど)、または実行されるイベントに関する何かを表示する。

Just before executing any command, the ConsoleEvents::COMMAND event is dispatched. Listeners receive a ConsoleCommandEvent event:

コマンドを実行する直前に、ConsoleEvents::COMMAND イベントが送出されます。リスナーは、ConsoleCommandEvent イベントを受け取ります。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 
use Symfony\Component\Console\ConsoleEvents;
use Symfony\Component\Console\Event\ConsoleCommandEvent;

$dispatcher->addListener(ConsoleEvents::COMMAND, function (ConsoleCommandEvent $event) {
    // gets the input instance
    $input = $event->getInput();

    // gets the output instance
    $output = $event->getOutput();

    // gets the command to be executed
    $command = $event->getCommand();

    // writes something about the command
    $output->writeln(sprintf('Before running command <info>%s</info>', $command->getName()));

    // gets the application
    $application = $command->getApplication();
});

Disable Commands inside Listeners

Using the disableCommand() method, you can disable a command inside a listener. The application will then not execute the command, but instead will return the code 113 (defined in ConsoleCommandEvent::RETURN_CODE_DISABLED). This code is one of the reserved exit codes for console commands that conform with the C/C++ standard:

disableCommand() メソッドを使用すると、リスナー内のコマンドを無効にできます。その後、アプリケーションはコマンドを実行せず、代わりにコード 113 (ConsoleCommandEvent::RETURN_CODE_DISABLED で定義) を返します。このコードは、C/C++ 標準に準拠するコンソール コマンド用に予約されている終了コードの 1 つです。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
 
use Symfony\Component\Console\ConsoleEvents;
use Symfony\Component\Console\Event\ConsoleCommandEvent;

$dispatcher->addListener(ConsoleEvents::COMMAND, function (ConsoleCommandEvent $event) {
    // gets the command to be executed
    $command = $event->getCommand();

    // ... check if the command can be executed

    // disables the command, this will result in the command being skipped
    // and code 113 being returned from the Application
    $event->disableCommand();

    // it is possible to enable the command in a later listener
    if (!$event->commandShouldRun()) {
        $event->enableCommand();
    }
});

The ConsoleEvents::ERROR Event

Typical Purposes: Handle exceptions thrown during the execution of a command.

一般的な目的: コマンドの実行中にスローされた例外を処理します。

Whenever an exception is thrown by a command, including those triggered from event listeners, the ConsoleEvents::ERROR event is dispatched. A listener can wrap or change the exception or do anything useful before the exception is thrown by the application.

イベントリスナーからトリガーされたものを含め、コマンドによって例外がスローされるたびに、ConsoleEvents::ERROR イベントが送出されます。リスナーは、アプリケーションによって例外がスローされる前に、例外をラップまたは変更したり、有用なことを実行したりできます。

Listeners receive a ConsoleErrorEvent event:

リスナーは、ConsoleErrorEvent イベントを受け取ります。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
 
use Symfony\Component\Console\ConsoleEvents;
use Symfony\Component\Console\Event\ConsoleErrorEvent;

$dispatcher->addListener(ConsoleEvents::ERROR, function (ConsoleErrorEvent $event) {
    $output = $event->getOutput();

    $command = $event->getCommand();

    $output->writeln(sprintf('Oops, exception thrown while running command <info>%s</info>', $command->getName()));

    // gets the current exit code (the exception code)
    $exitCode = $event->getExitCode();

    // changes the exception to another one
    $event->setError(new \LogicException('Caught exception', $exitCode, $event->getError()));
});

The ConsoleEvents::TERMINATE Event

Typical Purposes: To perform some cleanup actions after the command has been executed.

典型的な目的: コマンドが実行された後、いくつかのクリーンアップ アクションを実行します。

After the command has been executed, the ConsoleEvents::TERMINATE event is dispatched. It can be used to do any actions that need to be executed for all commands or to cleanup what you initiated in a ConsoleEvents::COMMAND listener (like sending logs, closing a database connection, sending emails, ...). A listener might also change the exit code.

コマンドが実行された後、ConsoleEvents::TERMINATE イベントが送出されます。すべてのコマンドに対して実行する必要があるアクションを実行したり、ConsoleEvents::COMMANDlistener で開始したものをクリーンアップしたりするために使用できます (ログの送信、データベース接続の終了、電子メールの送信など)。リスナーが終了コードを変更することもあります。

Listeners receive a ConsoleTerminateEvent event:

リスナーは、ConsoleTerminateEvent イベントを受け取ります。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
 
use Symfony\Component\Console\ConsoleEvents;
use Symfony\Component\Console\Event\ConsoleTerminateEvent;

$dispatcher->addListener(ConsoleEvents::TERMINATE, function (ConsoleTerminateEvent $event) {
    // gets the output
    $output = $event->getOutput();

    // gets the command that has been executed
    $command = $event->getCommand();

    // displays the given content
    $output->writeln(sprintf('After running command <info>%s</info>', $command->getName()));

    // changes the exit code
    $event->setExitCode(128);
});

Tip

ヒント

This event is also dispatched when an exception is thrown by the command. It is then dispatched just after the ConsoleEvents::ERROR event. The exit code received in this case is the exception code.

このイベントは、コマンドによって例外がスローされたときにも送出されます。次に、ConsoleEvents::ERROR イベントの直後に送出されます。この場合に受信される終了コードは、例外コードです。

The ConsoleEvents::SIGNAL Event

Typical Purposes: To perform some actions after the command execution was interrupted.

一般的な目的: コマンドの実行が中断された後に、いくつかのアクションを実行するため。

Signals are asynchronous notifications sent to a process in order to notify it of an event that occurred. For example, when you press Ctrl + C in a command, the operating system sends the SIGINT signal to it.

シグナルは、発生したイベントをプロセスに通知するためにプロセスに送信される非同期通知です。たとえば、コマンドで Ctrl + C を押すと、オペレーティング システムから SIGINT シグナルが送信されます。

When a command is interrupted, Symfony dispatches the ConsoleEvents::SIGNAL event. Listen to this event so you can perform some actions (e.g. logging some results, cleaning some temporary files, etc.) before finishing the command execution.

コマンドが中断されると、Symfony は ConsoleEvents::SIGNALevent を送出します。コマンドの実行を終了する前に、このイベントをリッスンして、いくつかのアクション (たとえば、いくつかの結果のログ記録、いくつかの一時ファイルの消去など) を実行できるようにします。

Listeners receive a ConsoleSignalEvent event:

リスナーは、ConsoleSignalEvent イベントを受け取ります。
1
2
3
4
5
6
7
8
9
10
11
12
 
use Symfony\Component\Console\ConsoleEvents;
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!";
    }
});

Tip

ヒント

All the available signals (SIGINT, SIGQUIT, etc.) are defined as constants of the PCNTL PHP extension.

利用可能なすべてのシグナル (SIGINT、SIGQUIT など) は、PCNTL PHP 拡張機能の定数として定義されています。

If you use the Console component inside a Symfony application, commands can handle signals themselves. To do so, implement the SignalableCommandInterface and subscribe to one or more signals:

Symfony アプリケーション内で Console コンポーネントを使用する場合、コマンドはシグナル自体を処理できます。これを行うには、SignalableCommandInterface を実装し、1 つ以上のシグナルをサブスクライブします。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
// src/Command/SomeCommand.php
namespace App\Command;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Command\SignalableCommandInterface;

class SomeCommand extends Command implements SignalableCommandInterface
{
    // ...

    public function getSubscribedSignals(): array
    {
        // return here any of the constants defined by PCNTL extension
        return [\SIGINT, \SIGTERM];
    }

    public function handleSignal(int $signal): void
    {
        if (\SIGINT === $signal) {
            // ...
        }

        // ...
    }
}