class ConsoleCommandEvent extends ConsoleEvent

Allows to do things before the command is executed, like skipping the command or changing the input.

Constants

RETURN_CODE_DISABLED

The return code for skipped commands, this will also be passed into the terminate event.

Properties

protected $command from ConsoleEvent

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) deprecated

Stores the EventDispatcher that dispatches this Event.

from Event
getDispatcher() deprecated

Returns the EventDispatcher that dispatches this Event.

from Event
string
getName() deprecated

Gets the event's name.

from Event
setName(string $name) deprecated

Sets the event's name property.

from Event
__construct(Command $command, InputInterface $input, OutputInterface $output)

No description

getCommand()

Gets the command that is executed.

getInput()

Gets the input instance.

getOutput()

Gets the output instance.

bool
disableCommand()

Disables the command, so it won't be run.

bool
enableCommand()

Enables the command.

bool
commandShouldRun()

Returns true if the command is runnable, false otherwise.

Details

in Event at line 52
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

in Event at line 64
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().

in Event at line 76
setDispatcher(EventDispatcherInterface $dispatcher) deprecated

deprecated since version 2.4, to be removed in 3.0. The event dispatcher is passed to the listener call.

Stores the EventDispatcher that dispatches this Event.

Parameters

EventDispatcherInterface $dispatcher

in Event at line 88
EventDispatcherInterface getDispatcher() deprecated

deprecated since version 2.4, to be removed in 3.0. The event dispatcher is passed to the listener call.

Returns the EventDispatcher that dispatches this Event.

in Event at line 102
string getName() deprecated

deprecated since version 2.4, to be removed in 3.0. The event name is passed to the listener call.

Gets the event's name.

Return Value

string

in Event at line 116
setName(string $name) deprecated

deprecated since version 2.4, to be removed in 3.0. The event name is passed to the listener call.

Sets the event's name property.

Parameters

string $name The event name

in ConsoleEvent at line 31
__construct(Command $command, InputInterface $input, OutputInterface $output)

Parameters

Command $command
InputInterface $input
OutputInterface $output

in ConsoleEvent at line 43
Command getCommand()

Gets the command that is executed.

Return Value

Command A Command instance

in ConsoleEvent at line 53
InputInterface getInput()

Gets the input instance.

Return Value

InputInterface An InputInterface instance

in ConsoleEvent at line 63
OutputInterface getOutput()

Gets the output instance.

Return Value

OutputInterface An OutputInterface instance

at line 36
bool disableCommand()

Disables the command, so it won't be run.

Return Value

bool

at line 46
bool enableCommand()

Enables the command.

Return Value

bool

at line 56
bool commandShouldRun()

Returns true if the command is runnable, false otherwise.

Return Value

bool