AbstractFormLoginAuthenticator
class AbstractFormLoginAuthenticator extends AbstractGuardAuthenticator
A base class to make form login authentication easier!
Traits
| TargetPathTrait | Trait to get (and set) the URL the user last visited before being forced to authenticate. |
Methods
| GuardTokenInterface | createAuthenticatedToken(UserInterface $user, string $providerKey) Shortcut to create a PostAuthenticationGuardToken for you, if you don't really care about which authenticated token you're using. | from AbstractGuardAuthenticator |
| Response|null | onAuthenticationFailure(Request $request, AuthenticationException $exception) Override to change what happens after a bad username/password is submitted. | |
| bool | supportsRememberMe() Does this method support remember me cookies? | |
| Response | start(Request $request, AuthenticationException $authException = null) Override to control what happens when the user hits a secure page but isn't logged in yet. |
Details
GuardTokenInterface createAuthenticatedToken(UserInterface $user, string $providerKey)
Shortcut to create a PostAuthenticationGuardToken for you, if you don't really care about which authenticated token you're using.
Parameters
| UserInterface | $user | |
| string | $providerKey | The provider (i.e. firewall) key |
Return Value
| GuardTokenInterface |
Response|null onAuthenticationFailure(Request $request, AuthenticationException $exception)
Override to change what happens after a bad username/password is submitted.
Parameters
| Request | $request | |
| AuthenticationException | $exception |
Return Value
| Response|null |
bool supportsRememberMe()
Does this method support remember me cookies?
Remember me cookie will be set if all of the following are met: A) This method returns true B) The rememberme key under your firewall is configured C) The "remember me" functionality is activated. This is usually done by having a _rememberme checkbox in your form, but can be configured by the "alwaysrememberme" and "remembermeparameter" parameters under the "remember_me" firewall key D) The onAuthenticationSuccess method returns a Response object
Return Value
| bool |
Response start(Request $request, AuthenticationException $authException = null)
Override to control what happens when the user hits a secure page but isn't logged in yet.
Parameters
| Request | $request | The request that resulted in an AuthenticationException |
| AuthenticationException | $authException | The exception that started the authentication process |
Return Value
| Response |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Security/Guard/Authenticator/AbstractFormLoginAuthenticator.html