Event\ConsoleCommandEvent (Component\Console)
Symfony\Component\Console\Event\ConsoleCommandEvent
class ConsoleCommandEvent extends ConsoleEvent
Allows to do things before the command is executed, like skipping the command or changing the input.
Constants
RETURN_CODE_DISABLED | The return code for skipped commands, this will also be passed into the terminate event. |
Methods
bool | isPropagationStopped() Returns whether further event listeners should be triggered. | from Event |
stopPropagation() Stops the propagation of the event to further event listeners. | from Event | |
setDispatcher(EventDispatcherInterface $dispatcher) Stores the EventDispatcher that dispatches this Event. | from Event | |
EventDispatcherInterface | getDispatcher() Returns the EventDispatcher that dispatches this Event. | from Event |
string | getName() Gets the event's name. | from Event |
setName(string $name) Sets the event's name property. | from Event | |
__construct(Command $command, InputInterface $input, OutputInterface $output) | from ConsoleEvent | |
Command | getCommand() Gets the command that is executed. | from ConsoleEvent |
InputInterface | getInput() Gets the input instance. | from ConsoleEvent |
OutputInterface | getOutput() Gets the output instance. | from ConsoleEvent |
bool | disableCommand() Disables the command, so it won't be run. | |
bool | enableCommand() Enables the command. | |
bool | commandShouldRun() Returns true if the command is runnable, false otherwise. |
Details
public bool isPropagationStopped()
Returns whether further event listeners should be triggered.
public stopPropagation()
Stops the propagation of the event to further event listeners.
If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().
public setDispatcher(EventDispatcherInterface $dispatcher)
Stores the EventDispatcher that dispatches this Event.
public EventDispatcherInterface getDispatcher()
Returns the EventDispatcher that dispatches this Event.
public string getName()
Gets the event's name.
public setName(string $name)
Sets the event's name property.
public __construct(Command $command, InputInterface $input, OutputInterface $output)
public Command getCommand()
Gets the command that is executed.
public InputInterface getInput()
Gets the input instance.
public OutputInterface getOutput()
Gets the output instance.
public bool disableCommand()
Disables the command, so it won't be run.
public bool enableCommand()
Enables the command.
public bool commandShouldRun()
Returns true if the command is runnable, false otherwise.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Console/Event/ConsoleCommandEvent.html