ConsoleCommandEvent
extends ConsoleEvent
in package
Allows to do things before the command is executed, like skipping the command or executing code before the command is going to be executed.
Changing the input arguments will have no effect.
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 : bool
- Indicates if the command should be run or skipped.
- $input : InputInterface
- $output : OutputInterface
- $propagationStopped : bool
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
- getCommand() : Command|null
- Gets the command that is executed.
- getInput() : InputInterface
- Gets the input instance.
- getOutput() : OutputInterface
- Gets the output instance.
- isPropagationStopped() : bool
- Is propagation stopped?
- stopPropagation() : void
- Stops the propagation of the event to further event listeners.
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
bool
$commandShouldRun
= true
$input
private
InputInterface
$input
$output
private
OutputInterface
$output
$propagationStopped
private
bool
$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()
public
enableCommand() : bool
Return values
boolgetCommand()
Gets the command that is executed.
public
getCommand() : Command|null
Return values
Command|nullgetInput()
Gets the input instance.
public
getInput() : InputInterface
Return values
InputInterfacegetOutput()
Gets the output instance.
public
getOutput() : OutputInterface
Return values
OutputInterfaceisPropagationStopped()
Is propagation stopped?
public
isPropagationStopped() : bool
This will typically only be used by the Dispatcher to determine if the previous listener halted propagation.
Return values
boolstopPropagation()
Stops the propagation of the event to further event listeners.
public
stopPropagation() : void
If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().