W3cubDocs

/Symfony 2.8

Symfony\Component\Console\Event\ConsoleExceptionEvent

class ConsoleExceptionEvent extends ConsoleEvent

Allows to handle exception thrown in 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
setDispatcher(EventDispatcherInterface $dispatcher)

Stores the EventDispatcher that dispatches this Event.

from Event
EventDispatcherInterface getDispatcher()

Returns the EventDispatcher that dispatches this Event.

from Event
string getName()

Gets the event's name.

from Event
setName(string $name)

Sets the event's name property.

from Event
__construct(Command $command, InputInterface $input, OutputInterface $output, Exception $exception, $exitCode)
Command 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
Exception getException()

Returns the thrown exception.

setException(Exception $exception)

Replaces the thrown exception.

int getExitCode()

Gets the exit code.

Details

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

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

public setDispatcher(EventDispatcherInterface $dispatcher)

Stores the EventDispatcher that dispatches this Event.

Parameters

EventDispatcherInterface $dispatcher

public EventDispatcherInterface getDispatcher()

Returns the EventDispatcher that dispatches this Event.

public string getName()

Gets the event's name.

Return Value

string

public setName(string $name)

Sets the event's name property.

Parameters

string $name The event name.

public __construct(Command $command, InputInterface $input, OutputInterface $output, Exception $exception, $exitCode)

Parameters

Command $command
InputInterface $input
OutputInterface $output
Exception $exception
$exitCode

public Command getCommand()

Gets the command that is executed.

Return Value

Command A Command instance

public InputInterface getInput()

Gets the input instance.

Return Value

InputInterface An InputInterface instance

public OutputInterface getOutput()

Gets the output instance.

Return Value

OutputInterface An OutputInterface instance

public Exception getException()

Returns the thrown exception.

Return Value

Exception The thrown exception

public setException(Exception $exception)

Replaces the thrown exception.

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

Parameters

Exception $exception The thrown exception

public int getExitCode()

Gets the exit code.

Return Value

int The command exit code

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Console/Event/ConsoleExceptionEvent.html