vendor/symfony/symfony/src/Symfony/Component/Security/Core/Authentication/Token/RememberMeToken.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.  * Authentication Token for "Remember-Me".
  18.  *
  19.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  20.  */
  21. class RememberMeToken extends AbstractToken
  22. {
  23.     private $secret;
  24.     private $providerKey;
  26.     /**
  27.      * @param string $secret A secret used to make sure the token is created by the app and not by a malicious client
  28.      *
  29.      * @throws \InvalidArgumentException
  30.      */
  31.     public function __construct(UserInterface $user, string $providerKey, string $secret)
  32.     {
  33.         parent::__construct($user->getRoles());
  35.         if (empty($secret)) {
  36.             throw new \InvalidArgumentException('$secret must not be empty.');
  37.         }
  39.         if (empty($providerKey)) {
  40.             throw new \InvalidArgumentException('$providerKey must not be empty.');
  41.         }
  43.         $this->providerKey = $providerKey;
  44.         $this->secret = $secret;
  46.         $this->setUser($user);
  47.         parent::setAuthenticated(true);
  48.     }
  50.     /**
  51.      * {@inheritdoc}
  52.      */
  53.     public function setAuthenticated($authenticated)
  54.     {
  55.         if ($authenticated) {
  56.             throw new \LogicException('You cannot set this token to authenticated after creation.');
  57.         }
  59.         parent::setAuthenticated(false);
  60.     }
  62.     /**
  63.      * Returns the provider secret.
  64.      *
  65.      * @return string The provider secret
  66.      */
  67.     public function getProviderKey()
  68.     {
  69.         return $this->providerKey;
  70.     }
  72.     /**
  73.      * Returns the secret.
  74.      *
  75.      * @return string
  76.      */
  77.     public function getSecret()
  78.     {
  79.         return $this->secret;
  80.     }
  82.     /**
  83.      * {@inheritdoc}
  84.      */
  85.     public function getCredentials()
  86.     {
  87.         return '';
  88.     }
  90.     /**
  91.      * {@inheritdoc}
  92.      */
  93.     public function __serialize(): array
  94.     {
  95.         return [$this->secret, $this->providerKey, parent::__serialize()];
  96.     }
  98.     /**
  99.      * {@inheritdoc}
  100.      */
  101.     public function __unserialize(array $data): void
  102.     {
  103.         [$this->secret, $this->providerKey, $parentData] = $data;
  104.         $parentData = \is_array($parentData) ? $parentData : unserialize($parentData);
  105.         parent::__unserialize($parentData);
  106.     }
  107. }