ConsoleErrorEvent
extends ConsoleEvent
in package
FinalYes
Allows to handle throwables thrown while running a command.
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- getCommand() : Command|null
- Gets the command that is executed.
- getError() : Throwable
- getExitCode() : int
- getInput() : InputInterface
- Gets the input instance.
- getOutput() : OutputInterface
- Gets the output instance.
- isPropagationStopped() : bool
- Is propagation stopped?
- setError() : void
- setExitCode() : void
- stopPropagation() : void
- Stops the propagation of the event to further event listeners.
Properties
$command
protected
Command|null
$command
Methods
__construct()
public
__construct(InputInterface $input, OutputInterface $output, Throwable $error[, Command|null $command = null ]) : mixed
Parameters
- $input : InputInterface
- $output : OutputInterface
- $error : Throwable
- $command : Command|null = null
getCommand()
Gets the command that is executed.
public
getCommand() : Command|null
Return values
Command|nullgetError()
public
getError() : Throwable
Return values
ThrowablegetExitCode()
public
getExitCode() : int
Return values
intgetInput()
Gets the input instance.
public
getInput() : InputInterface
Return values
InputInterfacegetOutput()
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
bool —True if the Event is complete and no further listeners should be called. False to continue calling listeners.
setError()
public
setError(Throwable $error) : void
Parameters
- $error : Throwable
setExitCode()
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().