vendor/symfony/security-http/Authenticator/AbstractAuthenticator.php line 38

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\Authenticator;
  14. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  15. use Symfony\Component\Security\Core\Exception\LogicException;
  16. use Symfony\Component\Security\Http\Authenticator\Passport\Passport;
  17. use Symfony\Component\Security\Http\Authenticator\Passport\PassportInterface;
  18. use Symfony\Component\Security\Http\Authenticator\Passport\UserPassportInterface;
  19. use Symfony\Component\Security\Http\Authenticator\Token\PostAuthenticationToken;
  21. /**
  22.  * An optional base class that creates the necessary tokens for you.
  23.  *
  24.  * @author Ryan Weaver <ryan@symfonycasts.com>
  25.  */
  26. abstract class AbstractAuthenticator implements AuthenticatorInterface
  27. {
  28.     /**
  29.      * Shortcut to create a PostAuthenticationToken for you, if you don't really
  30.      * care about which authenticated token you're using.
  31.      */
  32.     public function createToken(Passport $passport, string $firewallName): TokenInterface
  33.     {
  34.         if (self::class !== (new \ReflectionMethod($this, 'createAuthenticatedToken'))->getDeclaringClass()->getName() && self::class === (new \ReflectionMethod($this, 'createToken'))->getDeclaringClass()->getName()) {
  35.             return $this->createAuthenticatedToken($passport, $firewallName);
  36.         }
  38.         return new PostAuthenticationToken($passport->getUser(), $firewallName, $passport->getUser()->getRoles());
  39.     }
  41.     /**
  42.      * @deprecated since Symfony 5.4, use {@link createToken()} instead
  43.      */
  44.     public function createAuthenticatedToken(PassportInterface $passport, string $firewallName): TokenInterface
  45.     {
  46.         // @deprecated since Symfony 5.4
  47.         if (!$passport instanceof UserPassportInterface) {
  48.             throw new LogicException(sprintf('Passport does not contain a user, overwrite "createToken()" in "%s" to create a custom authentication token.', static::class));
  49.         }
  51.         trigger_deprecation('symfony/security-http', '5.4', 'Method "%s()" is deprecated, use "%s::createToken()" instead.', __METHOD__, __CLASS__);
  53.         return new PostAuthenticationToken($passport->getUser(), $firewallName, $passport->getUser()->getRoles());
  54.     }
  55. }