UsernamePasswordFormAuthenticationListener
class UsernamePasswordFormAuthenticationListener extends AbstractAuthenticationListener
UsernamePasswordFormAuthenticationListener is the default implementation of an authentication via a simple form composed of a username and a password.
Methods
__construct(TokenStorageInterface $tokenStorage, AuthenticationManagerInterface $authenticationManager, SessionAuthenticationStrategyInterface $sessionStrategy, HttpUtils $httpUtils, string $providerKey, AuthenticationSuccessHandlerInterface $successHandler, AuthenticationFailureHandlerInterface $failureHandler, array $options = array(), LoggerInterface $logger = null, EventDispatcherInterface $dispatcher = null, CsrfTokenManagerInterface $csrfTokenManager = null) Constructor. | ||
setRememberMeServices(RememberMeServicesInterface $rememberMeServices) Sets the RememberMeServices implementation to use. | from AbstractAuthenticationListener | |
handle(GetResponseEvent $event) Handles form based authentication. | from AbstractAuthenticationListener |
Details
__construct(TokenStorageInterface $tokenStorage, AuthenticationManagerInterface $authenticationManager, SessionAuthenticationStrategyInterface $sessionStrategy, HttpUtils $httpUtils, string $providerKey, AuthenticationSuccessHandlerInterface $successHandler, AuthenticationFailureHandlerInterface $failureHandler, array $options = array(), LoggerInterface $logger = null, EventDispatcherInterface $dispatcher = null, CsrfTokenManagerInterface $csrfTokenManager = null)
Constructor.
Parameters
TokenStorageInterface | $tokenStorage | A TokenStorageInterface instance |
AuthenticationManagerInterface | $authenticationManager | An AuthenticationManagerInterface instance |
SessionAuthenticationStrategyInterface | $sessionStrategy | |
HttpUtils | $httpUtils | An HttpUtilsInterface instance |
string | $providerKey | |
AuthenticationSuccessHandlerInterface | $successHandler | |
AuthenticationFailureHandlerInterface | $failureHandler | |
array | $options | An array of options for the processing of a successful, or failed authentication attempt |
LoggerInterface | $logger | A LoggerInterface instance |
EventDispatcherInterface | $dispatcher | An EventDispatcherInterface instance |
CsrfTokenManagerInterface | $csrfTokenManager |
Exceptions
InvalidArgumentException |
setRememberMeServices(RememberMeServicesInterface $rememberMeServices)
Sets the RememberMeServices implementation to use.
Parameters
RememberMeServicesInterface | $rememberMeServices |
final handle(GetResponseEvent $event)
Handles form based authentication.
Parameters
GetResponseEvent | $event |
Exceptions
RuntimeException | |
SessionUnavailableException |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.1/Symfony/Component/Security/Http/Firewall/UsernamePasswordFormAuthenticationListener.html