SwitchUserEvent
extends Event
in package
FinalYes
SwitchUserEvent.
Tags
Table of Contents
Properties
- $propagationStopped : bool
- $request : mixed
- $targetUser : mixed
- $token : mixed
Methods
- __construct() : mixed
- getRequest() : Request
- getTargetUser() : UserInterface
- getToken() : TokenInterface|null
- isPropagationStopped() : bool
- Is propagation stopped?
- setToken() : mixed
- stopPropagation() : void
- Stops the propagation of the event to further event listeners.
Properties
$propagationStopped
private
bool
$propagationStopped
= false
$request
private
mixed
$request
$targetUser
private
mixed
$targetUser
$token
private
mixed
$token
Methods
__construct()
public
__construct(Request $request, UserInterface $targetUser[, TokenInterface $token = null ]) : mixed
Parameters
- $request : Request
- $targetUser : UserInterface
- $token : TokenInterface = null
getRequest()
public
getRequest() : Request
Return values
RequestgetTargetUser()
public
getTargetUser() : UserInterface
Return values
UserInterfacegetToken()
public
getToken() : TokenInterface|null
Return values
TokenInterface|nullisPropagationStopped()
Is propagation stopped?
public
isPropagationStopped() : bool
Return values
bool —True if the Event is complete and no further listeners should be called. False to continue calling listeners.
setToken()
public
setToken(TokenInterface $token) : mixed
Parameters
- $token : TokenInterface
stopPropagation()
Stops the propagation of the event to further event listeners.
public
stopPropagation() : void
If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().