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
- RETURN_CODE_DISABLED = 113
- The return code for skipped commands, this will also be passed into the terminate event.
- $command : mixed
- $commandShouldRun : mixed
- Indicates if the command should be run or skipped.
- $input : mixed
- $output : mixed
- __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.
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
Methods
__construct()
public
__construct(Command|null $command, InputInterface $input, OutputInterface $output) : mixed
Parameters
- $command : Command|null
- $input : InputInterface
- $output : OutputInterface
Return values
mixed —commandShouldRun()
Returns true if the command is runnable, false otherwise.
public
commandShouldRun() : bool
Return values
bool —disableCommand()
Disables the command, so it won't be run.
public
disableCommand() : bool
Return values
bool —enableCommand()
public
enableCommand() : bool
Return values
bool —getCommand()
Gets the command that is executed.
public
getCommand() : Command|null
Return values
Command|null —getInput()
Gets the input instance.
public
getInput() : InputInterface
Return values
InputInterface —getOutput()
Gets the output instance.
public
getOutput() : OutputInterface