Documentation

ConsoleExceptionEvent extends ConsoleEvent
in package

Allows to handle exception thrown in a command.

Tags
author

Fabien Potencier fabien@symfony.com

deprecated

since version 3.3, to be removed in 4.0. Use ConsoleErrorEvent instead.

Table of Contents

$command  : mixed
$exception  : mixed
$exitCode  : mixed
$input  : mixed
$output  : mixed
$propagationStopped  : bool
__construct()  : mixed
getCommand()  : Command|null
Gets the command that is executed.
getException()  : Exception
Returns the thrown 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.
setException()  : mixed
Replaces the thrown exception.
stopPropagation()  : mixed
Stops the propagation of the event to further event listeners.

Properties

$propagationStopped

private bool $propagationStopped = false

Whether no further event listeners should be triggered

Methods

getCommand()

Gets the command that is executed.

public getCommand() : Command|null
Return values
Command|null —

A Command instance

getException()

Returns the thrown exception.

public getException() : Exception
Return values
Exception —

The thrown exception

getExitCode()

Gets the exit code.

public getExitCode() : int
Return values
int —

The command exit code

isPropagationStopped()

Returns whether further event listeners should be triggered.

public isPropagationStopped() : bool
Tags
see
Event::stopPropagation()
Return values
bool —

Whether propagation was already stopped for this event

setException()

Replaces the thrown exception.

public setException(Exception $exception) : mixed

This exception will be thrown if no response is set in the event.

Parameters
$exception : Exception

The thrown exception

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().

Return values
mixed —

Search results