LogoutListener

class LogoutListener implements ListenerInterface

LogoutListener logout users.

	__construct(TokenStorageInterface $tokenStorage, HttpUtils $httpUtils, LogoutSuccessHandlerInterface $successHandler, array $options = array(), CsrfTokenManagerInterface $csrfTokenManager = null) Constructor.
	addHandler(LogoutHandlerInterface $handler) Adds a logout handler.
	handle(GetResponseEvent $event) Performs the logout if requested.

Constructor.

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

Adds a logout handler.

$handler

Performs the logout if requested.

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

$event

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

Links:

doc_Symfony

2016-10-28 06:23:11

Comments