vendor/symfony/security-http/EntryPoint/AuthenticationEntryPointInterface.php line 45

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Security\Http\EntryPoint;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\HttpFoundation\Response;
  16. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  18. /**
  19.  * Implement this interface for any classes that will be called to "start"
  20.  * the authentication process (see method for more details).
  21.  *
  22.  * @author Fabien Potencier <fabien@symfony.com>
  23.  */
  24. interface AuthenticationEntryPointInterface
  25. {
  26.     /**
  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.      *
  35.      * - For a form login, you might redirect to the login page
  36.      *
  37.      *     return new RedirectResponse('/login');
  38.      *
  39.      * - For an API token authentication system, you return a 401 response
  40.      *
  41.      *     return new Response('Auth header required', 401);
  42.      *
  43.      * @return Response
  44.      */
  45.     public function start(Request $request, AuthenticationException $authException = null);
  46. }