vendor/symfony/security-http/Authenticator/AbstractLoginFormAuthenticator.php line 63

  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\Authenticator;
  14. use Symfony\Component\HttpFoundation\RedirectResponse;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpFoundation\Response;
  17. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  18. use Symfony\Component\Security\Http\EntryPoint\AuthenticationEntryPointInterface;
  19. use Symfony\Component\Security\Http\SecurityRequestAttributes;
  21. /**
  22.  * A base class to make form login authentication easier!
  23.  *
  24.  * @author Ryan Weaver <ryan@symfonycasts.com>
  25.  */
  26. abstract class AbstractLoginFormAuthenticator extends AbstractAuthenticator implements AuthenticationEntryPointInterface, InteractiveAuthenticatorInterface
  27. {
  28.     /**
  29.      * Return the URL to the login page.
  30.      */
  31.     abstract protected function getLoginUrl(Request $request): string;
  33.     /**
  34.      * Override to change the request conditions that have to be
  35.      * matched in order to handle the login form submit.
  36.      *
  37.      * This default implementation handles all POST requests to the
  38.      * login path (@see getLoginUrl()).
  39.      */
  40.     public function supports(Request $request): bool
  41.     {
  42.         return $request->isMethod('POST') && $this->getLoginUrl($request) === $request->getBaseUrl().$request->getPathInfo();
  43.     }
  45.     /**
  46.      * Override to change what happens after a bad username/password is submitted.
  47.      */
  48.     public function onAuthenticationFailure(Request $request, AuthenticationException $exception): Response
  49.     {
  50.         if ($request->hasSession()) {
  51.             $request->getSession()->set(SecurityRequestAttributes::AUTHENTICATION_ERROR, $exception);
  52.         }
  54.         $url = $this->getLoginUrl($request);
  56.         return new RedirectResponse($url);
  57.     }
  59.     /**
  60.      * Override to control what happens when the user hits a secure page
  61.      * but isn't logged in yet.
  62.      */
  63.     public function start(Request $request, AuthenticationException $authException = null): Response
  64.     {
  65.         $url = $this->getLoginUrl($request);
  67.         return new RedirectResponse($url);
  68.     }
  70.     public function isInteractive(): bool
  71.     {
  72.         return true;
  73.     }
  74. }