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 $providerKey;
  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                           $providerKey
  30.      * @param string[]                         $roles
  31.      *
  32.      * @throws \InvalidArgumentException
  33.      */
  34.     public function __construct($user, $credentials, string $providerKey, array $roles = [])
  35.     {
  36.         parent::__construct($roles);
  38.         if (empty($providerKey)) {
  39.             throw new \InvalidArgumentException('$providerKey must not be empty.');
  40.         }
  42.         $this->setUser($user);
  43.         $this->credentials = $credentials;
  44.         $this->providerKey = $providerKey;
  46.         parent::setAuthenticated(\count($roles) > 0);
  47.     }
  49.     /**
  50.      * {@inheritdoc}
  51.      */
  52.     public function setAuthenticated($isAuthenticated)
  53.     {
  54.         if ($isAuthenticated) {
  55.             throw new \LogicException('Cannot set this token to trusted after instantiation.');
  56.         }
  58.         parent::setAuthenticated(false);
  59.     }
  61.     /**
  62.      * {@inheritdoc}
  63.      */
  64.     public function getCredentials()
  65.     {
  66.         return $this->credentials;
  67.     }
  69.     /**
  70.      * Returns the provider key.
  71.      *
  72.      * @return string The provider key
  73.      */
  74.     public function getProviderKey()
  75.     {
  76.         return $this->providerKey;
  77.     }
  79.     /**
  80.      * {@inheritdoc}
  81.      */
  82.     public function eraseCredentials()
  83.     {
  84.         parent::eraseCredentials();
  86.         $this->credentials = null;
  87.     }
  89.     /**
  90.      * {@inheritdoc}
  91.      */
  92.     public function __serialize(): array
  93.     {
  94.         return [$this->credentials, $this->providerKey, parent::__serialize()];
  95.     }
  97.     /**
  98.      * {@inheritdoc}
  99.      */
  100.     public function __unserialize(array $data): void
  101.     {
  102.         [$this->credentials, $this->providerKey, $parentData] = $data;
  103.         parent::__unserialize($parentData);
  104.     }
  105. }