1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. Console
  7. \
  8. Event
  9. \
  10. ConsoleCommandEvent

ConsoleCommandEvent

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
__construct(Command $command = null, InputInterface $input, OutputInterface $output)

No description

from ConsoleEvent
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
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

bool isPropagationStopped()

Returns whether further event listeners should be triggered.

Return Value

bool Whether propagation was already stopped for this event

See also

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(Command $command = null, InputInterface $input, OutputInterface $output)

Parameters

Command $command
InputInterface $input
OutputInterface $output

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

bool disableCommand()

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

Return Value

bool

bool enableCommand()

Enables the command.

Return Value

bool

bool commandShouldRun()

Returns true if the command is runnable, false otherwise.

Return Value

bool