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
- $propagationStopped : 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.
- 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
mixed
$commandShouldRun
= true
$input
private
mixed
$input
$output
private
mixed
$output
$propagationStopped
private
mixed
$propagationStopped
= false
Methods
__construct()
public
__construct([Command $command = null ], 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 —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()
Is propagation stopped?
public
isPropagationStopped() : bool
Return values
bool —True if the Event is complete and no further listeners should be called. False to continue calling listeners.
stopPropagation()
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().