LogoutListener

class LogoutListener implements ListenerInterface

LogoutListener logout users.

Methods

__construct(TokenStorageInterface $tokenStorage, HttpUtils $httpUtils, LogoutSuccessHandlerInterface $successHandler, array $options = array(), CsrfTokenManagerInterface $csrfTokenManager = null)
addHandler(LogoutHandlerInterface $handler)
handle(GetResponseEvent $event)

Performs the logout if requested.

Details

__construct(TokenStorageInterface $tokenStorage, HttpUtils $httpUtils, LogoutSuccessHandlerInterface $successHandler, array $options = array(), CsrfTokenManagerInterface $csrfTokenManager = null)

Parameters

TokenStorageInterface $tokenStorage
HttpUtils $httpUtils An HttpUtils instance
LogoutSuccessHandlerInterface $successHandler A LogoutSuccessHandlerInterface instance
array $options An array of options to process a logout attempt
CsrfTokenManagerInterface $csrfTokenManager A CsrfTokenManagerInterface instance

addHandler(LogoutHandlerInterface $handler)

Parameters

LogoutHandlerInterface $handler

handle(GetResponseEvent $event)

Performs the logout if requested.

If a CsrfTokenManagerInterface instance is available, it will be used to validate the request.

Parameters

GetResponseEvent $event

Exceptions

LogoutException if the CSRF token is invalid
RuntimeException if the LogoutSuccessHandlerInterface instance does not return a response

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Security/Http/Firewall/LogoutListener.html