ConsoleErrorEvent

class ConsoleErrorEvent extends ConsoleEvent

Allows to handle throwables thrown while running a command.

Methods

bool isPropagationStopped()

Returns whether further event listeners should be triggered.

from Event
stopPropagation()

Stops the propagation of the event to further event listeners.

from Event
__construct(InputInterface $input, OutputInterface $output, $error, Command $command = null)
Command|null getCommand()

Gets the command that is executed.

from ConsoleEvent
InputInterface getInput()

Gets the input instance.

from ConsoleEvent
OutputInterface getOutput()

Gets the output instance.

from ConsoleEvent
Throwable getError()

Returns the thrown error/exception.

setError(Throwable $error)

Replaces the thrown error/exception.

setExitCode(int $exitCode)

Sets the exit code.

int getExitCode()

Gets the exit code.

Details

bool isPropagationStopped()

Returns whether further event listeners should be triggered.

Return Value

bool Whether propagation was already stopped for this event

See also

Event::stopPropagation()

stopPropagation()

Stops the propagation of the event to further event listeners.

If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().

__construct(InputInterface $input, OutputInterface $output, $error, Command $command = null)

Parameters

InputInterface $input
OutputInterface $output
$error
Command $command

Command|null getCommand()

Gets the command that is executed.

Return Value

Command|null A Command instance

InputInterface getInput()

Gets the input instance.

Return Value

InputInterface An InputInterface instance

OutputInterface getOutput()

Gets the output instance.

Return Value

OutputInterface An OutputInterface instance

Throwable getError()

Returns the thrown error/exception.

Return Value

Throwable

setError(Throwable $error)

Replaces the thrown error/exception.

Parameters

Throwable $error

setExitCode(int $exitCode)

Sets the exit code.

Parameters

int $exitCode The command exit code

int getExitCode()

Gets the exit code.

Return Value

int The command exit code

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.4/Symfony/Component/Console/Event/ConsoleErrorEvent.html