ConsoleEvent
class ConsoleEvent extends Event
Allows to inspect input and output of a command.
Methods
| Boolean | 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) | ||
| Command | getCommand() Gets the command that is executed. | |
| InputInterface | getInput() Gets the input instance. | |
| OutputInterface | getOutput() Gets the output instance. |
Details
Boolean isPropagationStopped()
Returns whether further event listeners should be triggered.
Return Value
| Boolean | Whether propagation was already stopped for this event. |
See also
| Event::stopPropagation |
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().
setDispatcher(EventDispatcherInterface $dispatcher)
Stores the EventDispatcher that dispatches this Event
Parameters
| EventDispatcherInterface | $dispatcher |
EventDispatcherInterface getDispatcher()
Returns the EventDispatcher that dispatches this Event
Return Value
| EventDispatcherInterface |
string getName()
Gets the event's name.
Return Value
| string |
setName(string $name)
Sets the event's name property.
Parameters
| string | $name | The event name. |
__construct(Command $command, InputInterface $input, OutputInterface $output)
Parameters
| Command | $command | |
| InputInterface | $input | |
| OutputInterface | $output |
Command getCommand()
Gets the command that is executed.
Return Value
| Command | A Command instance |
InputInterface getInput()
Gets the input instance.
Return Value
| InputInterface | An InputInterface instance |
OutputInterface getOutput()
Gets the output instance.
Return Value
| OutputInterface | An OutputInterface instance |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Console/Event/ConsoleEvent.html