Skip to content

Commit a235ce5

Browse files
author
Hugo Hamon
committed
[Security] backported phpdoc from Guard component.
1 parent 26fbfc8 commit a235ce5

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

EntryPoint/AuthenticationEntryPointInterface.php

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,17 @@
2424
interface AuthenticationEntryPointInterface
2525
{
2626
/**
27-
* Starts the authentication scheme.
27+
* Returns a response that directs the user to authenticate.
28+
*
29+
* This is called when an anonymous request accesses a resource that
30+
* requires authentication. The job of this method is to return some
31+
* response that "helps" the user start into the authentication process.
32+
*
33+
* Examples:
34+
* A) For a form login, you might redirect to the login page
35+
* return new RedirectResponse('/login');
36+
* B) For an API token authentication system, you return a 401 response
37+
* return new Response('Auth header required', 401);
2838
*
2939
* @param Request $request The request that resulted in an AuthenticationException
3040
* @param AuthenticationException $authException The exception that started the authentication process

0 commit comments

Comments
 (0)