AbstractAuthenticationListener
class AbstractAuthenticationListener implements ListenerInterface
The AbstractAuthenticationListener is the preferred base class for all browser-/HTTP-based authentication requests.
Subclasses likely have to implement the following: - an TokenInterface to hold authentication related data - an AuthenticationProvider to perform the actual authentication of the token, retrieve the UserInterface implementation from a database, and perform the specific account checks using the UserChecker
By default, this listener only is active for a specific path, e.g. /login_check. If you want to change this behavior, you can overwrite the requiresAuthentication() method.
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) | ||
| setRememberMeServices(RememberMeServicesInterface $rememberMeServices) Sets the RememberMeServices implementation to use. | ||
| handle(GetResponseEvent $event) Handles form based authentication. |
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)
Parameters
| TokenStorageInterface | $tokenStorage | |
| AuthenticationManagerInterface | $authenticationManager | |
| SessionAuthenticationStrategyInterface | $sessionStrategy | |
| HttpUtils | $httpUtils | |
| string | $providerKey | |
| AuthenticationSuccessHandlerInterface | $successHandler | |
| AuthenticationFailureHandlerInterface | $failureHandler | |
| array | $options | |
| LoggerInterface | $logger | |
| EventDispatcherInterface | $dispatcher |
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/4.0/Symfony/Component/Security/Http/Firewall/AbstractAuthenticationListener.html