ContextListener
extends AbstractListener
in package
implements
ListenerInterface
Uses
LegacyListenerTrait
ContextListener manages the SecurityContext persistence through a session.
Tags
Interfaces, Classes, Traits and Enums
- ListenerInterface
- Interface that must be implemented by firewall listeners.
Table of Contents
- $dispatcher : mixed
- $logger : mixed
- $registered : mixed
- $rememberMeServices : mixed
- $sessionKey : mixed
- $sessionTrackerEnabler : mixed
- $tokenStorage : mixed
- $trustResolver : mixed
- $userProviders : mixed
- __construct() : mixed
- __invoke() : mixed
- authenticate() : mixed
- Reads the Security Token from the session.
- onKernelResponse() : mixed
- Writes the security token into the session.
- setLogoutOnUserChange() : mixed
- Enables deauthentication during refreshUser when the user has changed.
- setRememberMeServices() : mixed
- supports() : bool|null
- Tells whether the authenticate() method should be called or not depending on the incoming request.
- refreshUser() : TokenInterface|null
- Refreshes the user by reloading it from the user provider.
- safelyUnserialize() : mixed
Properties
$dispatcher
private
mixed
$dispatcher
$logger
private
mixed
$logger
$registered
private
mixed
$registered
$rememberMeServices
private
mixed
$rememberMeServices
$sessionKey
private
mixed
$sessionKey
$sessionTrackerEnabler
private
mixed
$sessionTrackerEnabler
$tokenStorage
private
mixed
$tokenStorage
$trustResolver
private
mixed
$trustResolver
$userProviders
private
mixed
$userProviders
Methods
__construct()
public
__construct(TokenStorageInterface $tokenStorage, iteratable<string|int, mixed>|array<string|int, UserProviderInterface> $userProviders, string $contextKey[, LoggerInterface $logger = null ][, EventDispatcherInterface $dispatcher = null ][, AuthenticationTrustResolverInterface $trustResolver = null ][, callable $sessionTrackerEnabler = null ]) : mixed
Parameters
- $tokenStorage : TokenStorageInterface
- $userProviders : iteratable<string|int, mixed>|array<string|int, UserProviderInterface>
- $contextKey : string
- $logger : LoggerInterface = null
- $dispatcher : EventDispatcherInterface = null
- $trustResolver : AuthenticationTrustResolverInterface = null
- $sessionTrackerEnabler : callable = null
Return values
mixed —__invoke()
public
final __invoke(RequestEvent $event) : mixed
Parameters
- $event : RequestEvent
Return values
mixed —authenticate()
Reads the Security Token from the session.
public
authenticate(RequestEvent $event) : mixed
Parameters
- $event : RequestEvent
Return values
mixed —onKernelResponse()
Writes the security token into the session.
public
onKernelResponse(FilterResponseEvent $event) : mixed
Parameters
- $event : FilterResponseEvent
Return values
mixed —setLogoutOnUserChange()
Enables deauthentication during refreshUser when the user has changed.
public
setLogoutOnUserChange(bool $logoutOnUserChange) : mixed
Parameters
- $logoutOnUserChange : bool
Tags
Return values
mixed —setRememberMeServices()
public
setRememberMeServices(RememberMeServicesInterface $rememberMeServices) : mixed
Parameters
- $rememberMeServices : RememberMeServicesInterface
Return values
mixed —supports()
Tells whether the authenticate() method should be called or not depending on the incoming request.
public
supports(Request $request) : bool|null
Parameters
- $request : Request
Return values
bool|null —refreshUser()
Refreshes the user by reloading it from the user provider.
protected
refreshUser(TokenInterface $token) : TokenInterface|null
Parameters
- $token : TokenInterface
Tags
Return values
TokenInterface|null —safelyUnserialize()
private
safelyUnserialize(string $serializedToken) : mixed
Parameters
- $serializedToken : string