vendor/symfony/security-core/Authentication/Token/UsernamePasswordToken.php line 19

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. /**
  15.  * UsernamePasswordToken implements a username and password token.
  16.  *
  17.  * @author Fabien Potencier <fabien@symfony.com>
  18.  */
  19. class UsernamePasswordToken extends AbstractToken
  20. {
  21.     private $credentials;
  22.     private $providerKey;
  24.     /**
  25.      * @param string|object $user        The username (like a nickname, email address, etc.), or a UserInterface instance or an object implementing a __toString method
  26.      * @param mixed         $credentials This usually is the password of the user
  27.      * @param string        $providerKey The provider key
  28.      * @param string[]      $roles       An array of roles
  29.      *
  30.      * @throws \InvalidArgumentException
  31.      */
  32.     public function __construct($user, $credentials, string $providerKey, array $roles = [])
  33.     {
  34.         parent::__construct($roles);
  36.         if (empty($providerKey)) {
  37.             throw new \InvalidArgumentException('$providerKey must not be empty.');
  38.         }
  40.         $this->setUser($user);
  41.         $this->credentials = $credentials;
  42.         $this->providerKey = $providerKey;
  44.         parent::setAuthenticated(\count($roles) > 0);
  45.     }
  47.     /**
  48.      * {@inheritdoc}
  49.      */
  50.     public function setAuthenticated($isAuthenticated)
  51.     {
  52.         if ($isAuthenticated) {
  53.             throw new \LogicException('Cannot set this token to trusted after instantiation.');
  54.         }
  56.         parent::setAuthenticated(false);
  57.     }
  59.     /**
  60.      * {@inheritdoc}
  61.      */
  62.     public function getCredentials()
  63.     {
  64.         return $this->credentials;
  65.     }
  67.     /**
  68.      * Returns the provider key.
  69.      *
  70.      * @return string The provider key
  71.      */
  72.     public function getProviderKey()
  73.     {
  74.         return $this->providerKey;
  75.     }
  77.     /**
  78.      * {@inheritdoc}
  79.      */
  80.     public function eraseCredentials()
  81.     {
  82.         parent::eraseCredentials();
  84.         $this->credentials = null;
  85.     }
  87.     /**
  88.      * {@inheritdoc}
  89.      */
  90.     public function __serialize(): array
  91.     {
  92.         return [$this->credentials, $this->providerKey, parent::__serialize()];
  93.     }
  95.     /**
  96.      * {@inheritdoc}
  97.      */
  98.     public function __unserialize(array $data): void
  99.     {
  100.         [$this->credentials, $this->providerKey, $parentData] = $data;
  101.         parent::__unserialize($parentData);
  102.     }
  103. }