1. class
  2. Symfony
  3. Component
  4. Console
  5. Event
  6. ConsoleEvent

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)

No description

Command
getCommand()

Gets the command that is executed.

InputInterface
getInput()

Gets the input instance.

OutputInterface
getOutput()

Gets the output instance.

Details

in Event at line line 55
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

in Event at line line 69
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().

in Event at line line 81
setDispatcher(EventDispatcherInterface $dispatcher)

Stores the EventDispatcher that dispatches this Event

Parameters

EventDispatcherInterface $dispatcher

in Event at line line 93
EventDispatcherInterface getDispatcher()

Returns the EventDispatcher that dispatches this Event

Return Value

EventDispatcherInterface

in Event at line line 105
string getName()

Gets the event's name.

Return Value

string

in Event at line line 117
setName(string $name)

Sets the event's name property.

Parameters

string $name The event name.

at line line 31
__construct(Command $command, InputInterface $input, OutputInterface $output)

Parameters

Command $command
InputInterface $input
OutputInterface $output

at line line 43
Command getCommand()

Gets the command that is executed.

Return Value

Command A Command instance

at line line 53
InputInterface getInput()

Gets the input instance.

Return Value

InputInterface An InputInterface instance

at line line 63
OutputInterface getOutput()

Gets the output instance.

Return Value

OutputInterface An OutputInterface instance