ConsoleTerminateEvent
extends ConsoleEvent
in package
FinalYes
Allows to manipulate the exit code of a command after its execution.
Tags
Table of Contents
Properties
- $command : mixed
- $exitCode : int
- $input : InputInterface
- $interruptingSignal : int|null
- $output : OutputInterface
- $propagationStopped : bool
Methods
- __construct() : mixed
- getCommand() : Command|null
- Gets the command that is executed.
- getExitCode() : int
- getInput() : InputInterface
- Gets the input instance.
- getInterruptingSignal() : int|null
- getOutput() : OutputInterface
- Gets the output instance.
- isPropagationStopped() : bool
- Is propagation stopped?
- setExitCode() : void
- stopPropagation() : void
- Stops the propagation of the event to further event listeners.
Properties
$command
protected
mixed
$command
$exitCode
private
int
$exitCode
$input
private
InputInterface
$input
$interruptingSignal read-only
private
int|null
$interruptingSignal
= null
$output
private
OutputInterface
$output
$propagationStopped
private
bool
$propagationStopped
= false
Methods
__construct()
public
__construct(Command $command, InputInterface $input, OutputInterface $output, int $exitCode[, int|null $interruptingSignal = null ]) : mixed
Parameters
- $command : Command
- $input : InputInterface
- $output : OutputInterface
- $exitCode : int
- $interruptingSignal : int|null = null
getCommand()
Gets the command that is executed.
public
getCommand() : Command|null
Return values
Command|nullgetExitCode()
public
getExitCode() : int
Return values
intgetInput()
Gets the input instance.
public
getInput() : InputInterface
Return values
InputInterfacegetInterruptingSignal()
public
getInterruptingSignal() : int|null
Return values
int|nullgetOutput()
Gets the output instance.
public
getOutput() : OutputInterface
Return values
OutputInterfaceisPropagationStopped()
Is propagation stopped?
public
isPropagationStopped() : bool
This will typically only be used by the Dispatcher to determine if the previous listener halted propagation.
Return values
boolsetExitCode()
public
setExitCode(int $exitCode) : void
Parameters
- $exitCode : int
stopPropagation()
Stops the propagation of the event to further event listeners.
public
stopPropagation() : void
If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().