FormAuthenticationEntryPoint
class FormAuthenticationEntryPoint implements AuthenticationEntryPointInterface
FormAuthenticationEntryPoint starts an authentication via a login form.
Methods
__construct(HttpKernelInterface $kernel, HttpUtils $httpUtils, string $loginPath, bool $useForward = false) | ||
Response | start(Request $request, AuthenticationException $authException = null) Returns a response that directs the user to authenticate. |
Details
__construct(HttpKernelInterface $kernel, HttpUtils $httpUtils, string $loginPath, bool $useForward = false)
Parameters
HttpKernelInterface | $kernel | |
HttpUtils | $httpUtils | An HttpUtils instance |
string | $loginPath | The path to the login form |
bool | $useForward | Whether to forward or redirect to the login form |
Response start(Request $request, AuthenticationException $authException = null)
Returns a response that directs the user to authenticate.
This is called when an anonymous request accesses a resource that requires authentication. The job of this method is to return some response that "helps" the user start into the authentication process.
Examples: A) For a form login, you might redirect to the login page return new RedirectResponse('/login'); B) For an API token authentication system, you return a 401 response return new Response('Auth header required', 401);
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/Http/EntryPoint/FormAuthenticationEntryPoint.html