vendor/symfony/security-core/Authentication/Token/PreAuthenticatedToken.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\Core\Authentication\Token;
  14. use Symfony\Component\Security\Core\User\UserInterface;
  16. /**
  17.  * PreAuthenticatedToken implements a pre-authenticated token.
  18.  *
  19.  * @author Fabien Potencier <fabien@symfony.com>
  20.  */
  21. class PreAuthenticatedToken extends AbstractToken
  22. {
  23.     private $credentials;
  24.     private $firewallName;
  26.     /**
  27.      * @param UserInterface $user
  28.      * @param string        $firewallName
  29.      * @param string[]      $roles
  30.      */
  31.     public function __construct($user, /* string */ $firewallName, /* array */ $roles = [])
  32.     {
  33.         if (\is_string($roles)) {
  34.             trigger_deprecation('symfony/security-core', '5.4', 'Argument $credentials of "%s()" is deprecated.', __METHOD__);
  36.             $credentials = $firewallName;
  37.             $firewallName = $roles;
  38.             $roles = \func_num_args() > 3 ? func_get_arg(3) : [];
  39.         }
  41.         parent::__construct($roles);
  43.         if ('' === $firewallName) {
  44.             throw new \InvalidArgumentException('$firewallName must not be empty.');
  45.         }
  47.         $this->setUser($user);
  48.         $this->credentials = $credentials ?? null;
  49.         $this->firewallName = $firewallName;
  51.         if ($roles) {
  52.             $this->setAuthenticated(true, false);
  53.         }
  54.     }
  56.     /**
  57.      * Returns the provider key.
  58.      *
  59.      * @return string The provider key
  60.      *
  61.      * @deprecated since Symfony 5.2, use getFirewallName() instead
  62.      */
  63.     public function getProviderKey()
  64.     {
  65.         if (1 !== \func_num_args() || true !== func_get_arg(0)) {
  66.             trigger_deprecation('symfony/security-core', '5.2', 'Method "%s()" is deprecated, use "getFirewallName()" instead.', __METHOD__);
  67.         }
  69.         return $this->firewallName;
  70.     }
  72.     public function getFirewallName(): string
  73.     {
  74.         return $this->getProviderKey(true);
  75.     }
  77.     /**
  78.      * {@inheritdoc}
  79.      */
  80.     public function getCredentials()
  81.     {
  82.         trigger_deprecation('symfony/security-core', '5.4', 'Method "%s()" is deprecated.', __METHOD__);
  84.         return $this->credentials;
  85.     }
  87.     /**
  88.      * {@inheritdoc}
  89.      */
  90.     public function eraseCredentials()
  91.     {
  92.         parent::eraseCredentials();
  94.         $this->credentials = null;
  95.     }
  97.     /**
  98.      * {@inheritdoc}
  99.      */
  100.     public function __serialize(): array
  101.     {
  102.         return [$this->credentials, $this->firewallName, parent::__serialize()];
  103.     }
  105.     /**
  106.      * {@inheritdoc}
  107.      */
  108.     public function __unserialize(array $data): void
  109.     {
  110.         [$this->credentials, $this->firewallName, $parentData] = $data;
  111.         $parentData = \is_array($parentData) ? $parentData : unserialize($parentData);
  112.         parent::__unserialize($parentData);
  113.     }
  114. }