W3cubDocs

/Symfony 2.8

Symfony\Component\Console\Event\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

public 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

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

Parameters

EventDispatcherInterface $dispatcher

public EventDispatcherInterface getDispatcher()

Returns the EventDispatcher that dispatches this Event

public string getName()

Gets the event's name.

Return Value

string

public setName(string $name)

Sets the event's name property.

Parameters

string $name The event name.

public __construct(Command $command, InputInterface $input, OutputInterface $output)

Parameters

Command $command
InputInterface $input
OutputInterface $output

public Command getCommand()

Gets the command that is executed.

Return Value

Command A Command instance

public InputInterface getInput()

Gets the input instance.

Return Value

InputInterface An InputInterface instance

public OutputInterface getOutput()

Gets the output instance.

Return Value

OutputInterface An OutputInterface instance

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Console/Event/ConsoleEvent.html