Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. ConsoleEvents.php

class ConsoleEvents

Contains all events dispatched by an Application.

@author Francesco Levorato <git@flevour.net>

Hierarchy

  • class \Symfony\Component\Console\ConsoleEvents

Expanded class hierarchy of ConsoleEvents

3 files declare their use of ConsoleEvents
DebugHandlersListener.php in vendor/symfony/http-kernel/EventListener/DebugHandlersListener.php
DumpListener.php in vendor/symfony/http-kernel/EventListener/DumpListener.php
ErrorListener.php in vendor/symfony/console/EventListener/ErrorListener.php

File

vendor/symfony/console/ConsoleEvents.php, line 24

Namespace

Symfony\Component\Console
View source
final class ConsoleEvents {
    
    /**
     * The COMMAND event allows you to attach listeners before any command is
     * executed by the console. It also allows you to modify the command, input and output
     * before they are handed to the command.
     *
     * @Event("Symfony\Component\Console\Event\ConsoleCommandEvent")
     */
    public const COMMAND = 'console.command';
    
    /**
     * The SIGNAL event allows you to perform some actions
     * after the command execution was interrupted.
     *
     * @Event("Symfony\Component\Console\Event\ConsoleSignalEvent")
     */
    public const SIGNAL = 'console.signal';
    
    /**
     * The TERMINATE event allows you to attach listeners after a command is
     * executed by the console.
     *
     * @Event("Symfony\Component\Console\Event\ConsoleTerminateEvent")
     */
    public const TERMINATE = 'console.terminate';
    
    /**
     * The ERROR event occurs when an uncaught exception or error appears.
     *
     * This event allows you to deal with the exception/error or
     * to modify the thrown exception.
     *
     * @Event("Symfony\Component\Console\Event\ConsoleErrorEvent")
     */
    public const ERROR = 'console.error';
    
    /**
     * Event aliases.
     *
     * These aliases can be consumed by RegisterListenersPass.
     */
    public const ALIASES = [
        ConsoleCommandEvent::class => self::COMMAND,
        ConsoleErrorEvent::class => self::ERROR,
        ConsoleSignalEvent::class => self::SIGNAL,
        ConsoleTerminateEvent::class => self::TERMINATE,
    ];

}

Members

Title Sort descending Modifiers Object type Summary
ConsoleEvents::ALIASES public constant Event aliases.
ConsoleEvents::COMMAND public constant The COMMAND event allows you to attach listeners before any command is
executed by the console. It also allows you to modify the command, input and output
before they are handed to the command.
ConsoleEvents::ERROR public constant The ERROR event occurs when an uncaught exception or error appears.
ConsoleEvents::SIGNAL public constant The SIGNAL event allows you to perform some actions
after the command execution was interrupted.
ConsoleEvents::TERMINATE public constant The TERMINATE event allows you to attach listeners after a command is
executed by the console.
RSS feed
Powered by Drupal