CommandEvent
extends Event
in package
An event for all commands.
Tags
Table of Contents
- $args : array<string|int, mixed>
- $flags : array<string|int, mixed>
- $name : string
- $commandName : string
- $input : InputInterface
- $output : OutputInterface
- $propagationStopped : bool
- __construct() : mixed
- Constructor.
- getArguments() : array<string|int, mixed>
- Returns the event's arguments.
- getCommandName() : string
- Retrieves the name of the command being run
- getFlags() : array<string|int, mixed>
- Returns the event's flags.
- getInput() : InputInterface
- Returns the command input interface
- getName() : string
- Returns the event's name.
- getOutput() : OutputInterface
- Retrieves the command output interface
- isPropagationStopped() : bool
- Checks if stopPropagation has been called
- stopPropagation() : mixed
- Prevents the event from being passed to further listeners
Properties
$args
protected
array<string|int, mixed>
$args
Arguments passed by the user, these will be forwarded to CLI script handlers
$flags
protected
array<string|int, mixed>
$flags
Flags usable in PHP script handlers
$name
protected
string
$name
This event's name
$commandName
private
string
$commandName
$input
private
InputInterface
$input
$output
private
OutputInterface
$output
$propagationStopped
private
bool
$propagationStopped
= false
Whether the event should not be passed to more listeners
Methods
__construct()
Constructor.
public
__construct(string $name, string $commandName, InputInterface $input, OutputInterface $output[, array<string|int, mixed> $args = array() ][, array<string|int, mixed> $flags = array() ]) : mixed
Parameters
- $name : string
-
The event name
- $commandName : string
-
The command name
- $input : InputInterface
- $output : OutputInterface
- $args : array<string|int, mixed> = array()
-
Arguments passed by the user
- $flags : array<string|int, mixed> = array()
-
Optional flags to pass data not as argument
Return values
mixed —getArguments()
Returns the event's arguments.
public
getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed> —The event arguments
getCommandName()
Retrieves the name of the command being run
public
getCommandName() : string
Return values
string —getFlags()
Returns the event's flags.
public
getFlags() : array<string|int, mixed>
Return values
array<string|int, mixed> —The event flags
getInput()
Returns the command input interface
public
getInput() : InputInterface
Return values
InputInterface —getName()
Returns the event's name.
public
getName() : string
Return values
string —The event name
getOutput()
Retrieves the command output interface
public
getOutput() : OutputInterface
Return values
OutputInterface —isPropagationStopped()
Checks if stopPropagation has been called
public
isPropagationStopped() : bool
Return values
bool —Whether propagation has been stopped
stopPropagation()
Prevents the event from being passed to further listeners
public
stopPropagation() : mixed