vendor/symfony/security-core/Authentication/Token/UsernamePasswordToken.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.  * UsernamePasswordToken implements a username and password token.
  18.  *
  19.  * @author Fabien Potencier <fabien@symfony.com>
  20.  */
  21. class UsernamePasswordToken extends AbstractToken
  22. {
  23.     private $credentials;
  24.     private $firewallName;
  26.     /**
  27.      * @param string|\Stringable|UserInterface $user        The username (like a nickname, email address, etc.) or a UserInterface instance
  28.      * @param mixed                            $credentials
  29.      * @param string[]                         $roles
  30.      *
  31.      * @throws \InvalidArgumentException
  32.      */
  33.     public function __construct($user, $credentials, string $firewallName, array $roles = [])
  34.     {
  35.         parent::__construct($roles);
  37.         if ('' === $firewallName) {
  38.             throw new \InvalidArgumentException('$firewallName must not be empty.');
  39.         }
  41.         $this->setUser($user);
  42.         $this->credentials = $credentials;
  43.         $this->firewallName = $firewallName;
  45.         parent::setAuthenticated(\count($roles) > 0);
  46.     }
  48.     /**
  49.      * {@inheritdoc}
  50.      */
  51.     public function setAuthenticated(bool $isAuthenticated)
  52.     {
  53.         if ($isAuthenticated) {
  54.             throw new \LogicException('Cannot set this token to trusted after instantiation.');
  55.         }
  57.         parent::setAuthenticated(false);
  58.     }
  60.     /**
  61.      * {@inheritdoc}
  62.      */
  63.     public function getCredentials()
  64.     {
  65.         return $this->credentials;
  66.     }
  68.     /**
  69.      * Returns the provider key.
  70.      *
  71.      * @return string The provider key
  72.      *
  73.      * @deprecated since 5.2, use getFirewallName() instead
  74.      */
  75.     public function getProviderKey()
  76.     {
  77.         if (1 !== \func_num_args() || true !== func_get_arg(0)) {
  78.             trigger_deprecation('symfony/security-core', '5.2', 'Method "%s" is deprecated, use "getFirewallName()" instead.', __METHOD__);
  79.         }
  81.         return $this->firewallName;
  82.     }
  84.     public function getFirewallName(): string
  85.     {
  86.         return $this->getProviderKey(true);
  87.     }
  89.     /**
  90.      * {@inheritdoc}
  91.      */
  92.     public function eraseCredentials()
  93.     {
  94.         parent::eraseCredentials();
  96.         $this->credentials = null;
  97.     }
  99.     /**
  100.      * {@inheritdoc}
  101.      */
  102.     public function __serialize(): array
  103.     {
  104.         return [$this->credentials, $this->firewallName, parent::__serialize()];
  105.     }
  107.     /**
  108.      * {@inheritdoc}
  109.      */
  110.     public function __unserialize(array $data): void
  111.     {
  112.         [$this->credentials, $this->firewallName, $parentData] = $data;
  113.         $parentData = \is_array($parentData) ? $parentData : unserialize($parentData);
  114.         parent::__unserialize($parentData);
  115.     }
  116. }