W3cubDocs

/Symfony 4.1

RetryAuthenticationEntryPoint

class RetryAuthenticationEntryPoint implements AuthenticationEntryPointInterface

RetryAuthenticationEntryPoint redirects URL based on the configured scheme.

This entry point is not intended to work with HTTP post requests.

Methods

__construct(int $httpPort = 80, int $httpsPort = 443)
Response start(Request $request, AuthenticationException $authException = null)

Returns a response that directs the user to authenticate.

Details

__construct(int $httpPort = 80, int $httpsPort = 443)

Parameters

int $httpPort
int $httpsPort

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:

  • For a form login, you might redirect to the login page

    return new RedirectResponse('/login');

  • 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