W3cubDocs

/Symfony 4.1

ContextListener

class ContextListener implements ListenerInterface

ContextListener manages the SecurityContext persistence through a session.

Methods

__construct(TokenStorageInterface $tokenStorage, iterable $userProviders, string $contextKey, LoggerInterface $logger = null, EventDispatcherInterface $dispatcher = null, AuthenticationTrustResolverInterface $trustResolver = null)
setLogoutOnUserChange(bool $logoutOnUserChange) deprecated

Enables deauthentication during refreshUser when the user has changed.

handle(GetResponseEvent $event)

Reads the Security Token from the session.

onKernelResponse(FilterResponseEvent $event)

Writes the security token into the session.

TokenInterface|null refreshUser(TokenInterface $token)

Refreshes the user by reloading it from the user provider.

static handleUnserializeCallback($class)

Details

__construct(TokenStorageInterface $tokenStorage, iterable $userProviders, string $contextKey, LoggerInterface $logger = null, EventDispatcherInterface $dispatcher = null, AuthenticationTrustResolverInterface $trustResolver = null)

Parameters

TokenStorageInterface $tokenStorage
iterable $userProviders
string $contextKey
LoggerInterface $logger
EventDispatcherInterface $dispatcher
AuthenticationTrustResolverInterface $trustResolver

setLogoutOnUserChange(bool $logoutOnUserChange) deprecated

deprecated

since Symfony 4.1

Enables deauthentication during refreshUser when the user has changed.

Parameters

bool $logoutOnUserChange

handle(GetResponseEvent $event)

Reads the Security Token from the session.

Parameters

GetResponseEvent $event

onKernelResponse(FilterResponseEvent $event)

Writes the security token into the session.

Parameters

FilterResponseEvent $event

protected TokenInterface|null refreshUser(TokenInterface $token)

Refreshes the user by reloading it from the user provider.

Parameters

TokenInterface $token

Return Value

TokenInterface|null

Exceptions

RuntimeException

static handleUnserializeCallback($class)

Parameters

$class

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Security/Http/Firewall/ContextListener.html