ConsoleErrorEvent
extends ConsoleEvent
in package
Allows to handle throwables thrown while running a command.
Tags
Table of Contents
- $command : mixed
- $error : mixed
- $exitCode : mixed
- $input : mixed
- $output : mixed
- $propagationStopped : bool
- __construct() : mixed
- getCommand() : Command|null
- Gets the command that is executed.
- getError() : Throwable
- Returns the thrown error/exception.
- getExitCode() : int
- Gets the exit code.
- getInput() : InputInterface
- Gets the input instance.
- getOutput() : OutputInterface
- Gets the output instance.
- isPropagationStopped() : bool
- Returns whether further event listeners should be triggered.
- setError() : mixed
- Replaces the thrown error/exception.
- setExitCode() : mixed
- Sets the exit code.
- stopPropagation() : mixed
- Stops the propagation of the event to further event listeners.
Properties
$command
protected
mixed
$command
$error
private
mixed
$error
$exitCode
private
mixed
$exitCode
$input
private
mixed
$input
$output
private
mixed
$output
$propagationStopped
private
bool
$propagationStopped
= false
Whether no further event listeners should be triggered
Methods
__construct()
public
__construct(InputInterface $input, OutputInterface $output, mixed $error[, Command $command = null ]) : mixed
Parameters
- $input : InputInterface
- $output : OutputInterface
- $error : mixed
- $command : Command = null
Return values
mixed —getCommand()
Gets the command that is executed.
public
getCommand() : Command|null
Return values
Command|null —A Command instance
getError()
Returns the thrown error/exception.
public
getError() : Throwable
Return values
Throwable —getExitCode()
Gets the exit code.
public
getExitCode() : int
Return values
int —The command exit code
getInput()
Gets the input instance.
public
getInput() : InputInterface
Return values
InputInterface —An InputInterface instance
getOutput()
Gets the output instance.
public
getOutput() : OutputInterface
Return values
OutputInterface —An OutputInterface instance
isPropagationStopped()
Returns whether further event listeners should be triggered.
public
isPropagationStopped() : bool
Tags
Return values
bool —Whether propagation was already stopped for this event
setError()
Replaces the thrown error/exception.
public
setError(Throwable $error) : mixed
Parameters
- $error : Throwable
Return values
mixed —setExitCode()
Sets the exit code.
public
setExitCode(int $exitCode) : mixed
Parameters
- $exitCode : int
-
The command exit code
Return values
mixed —stopPropagation()
Stops the propagation of the event to further event listeners.
public
stopPropagation() : mixed
If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().