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

Breadcrumb

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

class ConsoleSignalEvent

@author marie <marie@users.noreply.github.com>

Hierarchy

  • class \Symfony\Contracts\EventDispatcher\Event implements \Psr\EventDispatcher\StoppableEventInterface
    • class \Symfony\Component\Console\Event\ConsoleEvent extends \Symfony\Contracts\EventDispatcher\Event
      • class \Symfony\Component\Console\Event\ConsoleSignalEvent extends \Symfony\Component\Console\Event\ConsoleEvent

Expanded class hierarchy of ConsoleSignalEvent

2 files declare their use of ConsoleSignalEvent
Application.php in vendor/symfony/console/Application.php
ConsoleEvents.php in vendor/symfony/console/ConsoleEvents.php

File

vendor/symfony/console/Event/ConsoleSignalEvent.php, line 21

Namespace

Symfony\Component\Console\Event
View source
final class ConsoleSignalEvent extends ConsoleEvent {
    public function __construct(Command $command, InputInterface $input, OutputInterface $output, int $handlingSignal, int|false $exitCode = 0) {
        parent::__construct($command, $input, $output);
    }
    public function getHandlingSignal() : int {
        return $this->handlingSignal;
    }
    public function setExitCode(int $exitCode) : void {
        if ($exitCode < 0 || $exitCode > 255) {
            throw new \InvalidArgumentException('Exit code must be between 0 and 255.');
        }
        $this->exitCode = $exitCode;
    }
    public function abortExit() : void {
        $this->exitCode = false;
    }
    public function getExitCode() : int|false {
        return $this->exitCode;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConsoleEvent::getCommand public function Gets the command that is executed.
ConsoleEvent::getInput public function Gets the input instance.
ConsoleEvent::getOutput public function Gets the output instance.
ConsoleSignalEvent::abortExit public function
ConsoleSignalEvent::getExitCode public function
ConsoleSignalEvent::getHandlingSignal public function
ConsoleSignalEvent::setExitCode public function
ConsoleSignalEvent::__construct public function Overrides ConsoleEvent::__construct
Event::$propagationStopped private property
Event::isPropagationStopped public function Is propagation stopped? Overrides StoppableEventInterface::isPropagationStopped
Event::stopPropagation public function Stops the propagation of the event to further event listeners. 1

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal