SwitchUserEvent

class SwitchUserEvent extends Event

SwitchUserEvent.

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(Request $request, UserInterface $targetUser)
Request	getRequest()
UserInterface	getTargetUser()

Details

bool isPropagationStopped()

Returns whether further event listeners should be triggered.

Return Value

bool	Whether propagation was already stopped for this event.

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

since version 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

since version 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

since version 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

since version 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(Request $request, UserInterface $targetUser)

Parameters

Request	$request
UserInterface	$targetUser

Request getRequest()

Return Value

Request

UserInterface getTargetUser()

Return Value

UserInterface

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.1/Symfony/Component/Security/Http/Event/SwitchUserEvent.html

SwitchUserEvent