vendor/symfony/security/Http/Authentication/SimpleAuthenticationHandler.php line 21

Open in your IDE?
  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\Authentication;
  14. use Psr\Log\LoggerInterface;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpFoundation\Response;
  17. use Symfony\Component\Security\Core\Authentication\SimpleAuthenticatorInterface;
  18. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  19. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  21. @trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.2, use Guard instead.', SimpleAuthenticationHandler::class), \E_USER_DEPRECATED);
  23. /**
  24.  * Class to proxy authentication success/failure handlers.
  25.  *
  26.  * Events are sent to the SimpleAuthenticatorInterface if it implements
  27.  * the right interface, otherwise (or if it fails to return a Response)
  28.  * the default handlers are triggered.
  29.  *
  30.  * @author Jordi Boggiano <j.boggiano@seld.be>
  31.  *
  32.  * @deprecated since Symfony 4.2, use Guard instead.
  33.  */
  34. class SimpleAuthenticationHandler implements AuthenticationFailureHandlerInterface, AuthenticationSuccessHandlerInterface
  35. {
  36.     protected $successHandler;
  37.     protected $failureHandler;
  38.     protected $simpleAuthenticator;
  39.     protected $logger;
  41.     public function __construct(SimpleAuthenticatorInterface $authenticator, AuthenticationSuccessHandlerInterface $successHandler, AuthenticationFailureHandlerInterface $failureHandler, LoggerInterface $logger = null)
  42.     {
  43.         $this->simpleAuthenticator = $authenticator;
  44.         $this->successHandler = $successHandler;
  45.         $this->failureHandler = $failureHandler;
  46.         $this->logger = $logger;
  47.     }
  49.     /**
  50.      * {@inheritdoc}
  51.      */
  52.     public function onAuthenticationSuccess(Request $request, TokenInterface $token)
  53.     {
  54.         if ($this->simpleAuthenticator instanceof AuthenticationSuccessHandlerInterface) {
  55.             if ($this->logger) {
  56.                 $this->logger->debug('Selected an authentication success handler.', ['handler' => \get_class($this->simpleAuthenticator)]);
  57.             }
  59.             $response = $this->simpleAuthenticator->onAuthenticationSuccess($request, $token);
  60.             if ($response instanceof Response) {
  61.                 return $response;
  62.             }
  64.             if (null !== $response) {
  65.                 throw new \UnexpectedValueException(sprintf('The "%s::onAuthenticationSuccess()" method must return null to use the default success handler, or a Response object.', \get_class($this->simpleAuthenticator)));
  66.             }
  67.         }
  69.         if ($this->logger) {
  70.             $this->logger->debug('Fallback to the default authentication success handler.');
  71.         }
  73.         return $this->successHandler->onAuthenticationSuccess($request, $token);
  74.     }
  76.     /**
  77.      * {@inheritdoc}
  78.      */
  79.     public function onAuthenticationFailure(Request $request, AuthenticationException $exception)
  80.     {
  81.         if ($this->simpleAuthenticator instanceof AuthenticationFailureHandlerInterface) {
  82.             if ($this->logger) {
  83.                 $this->logger->debug('Selected an authentication failure handler.', ['handler' => \get_class($this->simpleAuthenticator)]);
  84.             }
  86.             $response = $this->simpleAuthenticator->onAuthenticationFailure($request, $exception);
  87.             if ($response instanceof Response) {
  88.                 return $response;
  89.             }
  91.             if (null !== $response) {
  92.                 throw new \UnexpectedValueException(sprintf('The "%s::onAuthenticationFailure()" method must return null to use the default failure handler, or a Response object.', \get_class($this->simpleAuthenticator)));
  93.             }
  94.         }
  96.         if ($this->logger) {
  97.             $this->logger->debug('Fallback to the default authentication failure handler.');
  98.         }
  100.         return $this->failureHandler->onAuthenticationFailure($request, $exception);
  101.     }
  102. }