FormEvent

class FormEvent extends 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) deprecated

Stores the EventDispatcher that dispatches this Event

from Event
EventDispatcherInterface getDispatcher() deprecated

Returns the EventDispatcher that dispatches this Event

from Event
string getName() deprecated

Gets the event's name.

from Event
setName(string $name) deprecated

Sets the event's name property.

from Event
__construct(FormInterface $form, mixed $data)

Constructs an event.

FormInterface getForm()

Returns the form at the source of the event.

mixed getData()

Returns the data associated with this event.

setData(mixed $data)

Allows updating with some filtered data.

Details

bool isPropagationStopped()

Returns whether further event listeners should be triggered.

Return Value

bool 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) deprecated

deprecated

Deprecated in 2.4, to be removed in 3.0. The event dispatcher is passed to the listener call.

Stores the EventDispatcher that dispatches this Event

Parameters

EventDispatcherInterface $dispatcher

EventDispatcherInterface getDispatcher() deprecated

deprecated

Deprecated in 2.4, to be removed in 3.0. The event dispatcher is passed to the listener call.

Returns the EventDispatcher that dispatches this Event

Return Value

EventDispatcherInterface

string getName() deprecated

deprecated

Deprecated in 2.4, to be removed in 3.0. The event name is passed to the listener call.

Gets the event's name.

Return Value

string

setName(string $name) deprecated

deprecated

Deprecated in 2.4, to be removed in 3.0. The event name is passed to the listener call.

Sets the event's name property.

Parameters

string $name The event name.

__construct(FormInterface $form, mixed $data)

Constructs an event.

Parameters

FormInterface $form The associated form
mixed $data The data

FormInterface getForm()

Returns the form at the source of the event.

Return Value

FormInterface

mixed getData()

Returns the data associated with this event.

Return Value

mixed

setData(mixed $data)

Allows updating with some filtered data.

Parameters

mixed $data

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Form/FormEvent.html