ConsoleCommandEvent
extends ConsoleEvent
in package
Allows to do things before the command is executed, like skipping the command or changing the input.
Tags
Table of Contents
Constants
- RETURN_CODE_DISABLED = 113
- The return code for skipped commands, this will also be passed into the terminate event.
Properties
- $command : mixed
- $commandShouldRun : mixed
- Indicates if the command should be run or skipped.
- $input : mixed
- $output : mixed
- $propagationStopped : mixed
Methods
- __construct() : mixed
- commandShouldRun() : bool
- Returns true if the command is runnable, false otherwise.
- disableCommand() : bool
- Disables the command, so it won't be run.
- enableCommand() : bool
- Enables the command.
- getCommand() : Command|null
- Gets the command that is executed.
- getInput() : InputInterface
- Gets the input instance.
- getOutput() : OutputInterface
- Gets the output instance.
- isPropagationStopped() : bool
- stopPropagation() : mixed
Constants
RETURN_CODE_DISABLED
The return code for skipped commands, this will also be passed into the terminate event.
public
mixed
RETURN_CODE_DISABLED
= 113
Properties
$command
protected
mixed
$command
$commandShouldRun
Indicates if the command should be run or skipped.
private
mixed
$commandShouldRun
= true
$input
private
mixed
$input
$output
private
mixed
$output
$propagationStopped
private
mixed
$propagationStopped
= false
Methods
__construct()
public
__construct(Command|null $command, InputInterface $input, OutputInterface $output) : mixed
Parameters
- $command : Command|null
- $input : InputInterface
- $output : OutputInterface
commandShouldRun()
Returns true if the command is runnable, false otherwise.
public
commandShouldRun() : bool
Return values
booldisableCommand()
Disables the command, so it won't be run.
public
disableCommand() : bool
Return values
boolenableCommand()
Enables the command.
public
enableCommand() : bool
Return values
boolgetCommand()
Gets the command that is executed.
public
getCommand() : Command|null
Return values
Command|null —A Command instance
getInput()
Gets the input instance.
public
getInput() : InputInterface
Return values
InputInterface —An InputInterface instance
getOutput()
Gets the output instance.
public
getOutput() : OutputInterface
Return values
OutputInterface —An OutputInterface instance
isPropagationStopped()
public
isPropagationStopped() : bool
since Symfony 4.3, use "Symfony\Contracts\EventDispatcher\Event" instead
Return values
bool —Whether propagation was already stopped for this event
stopPropagation()
public
stopPropagation() : mixed
since Symfony 4.3, use "Symfony\Contracts\EventDispatcher\Event" instead