vendor/symfony/security-core/Authentication/Token/RememberMeToken.php line 21

  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\Exception\InvalidArgumentException;
  15. use Symfony\Component\Security\Core\User\UserInterface;
  17. /**
  18.  * Authentication Token for "Remember-Me".
  19.  *
  20.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  21.  */
  22. class RememberMeToken extends AbstractToken
  23. {
  24.     private ?string $secret = null;
  26.     /**
  27.      * @throws \InvalidArgumentException
  28.      */
  29.     public function __construct(
  30.         UserInterface $user,
  31.         private string $firewallName,
  32.     ) {
  33.         parent::__construct($user->getRoles());
  35.         if (\func_num_args() > 2) {
  36.             trigger_deprecation('symfony/security-core', '7.2', 'The "$secret" argument of "%s()" is deprecated.', __METHOD__);
  37.             $this->secret = func_get_arg(2);
  38.         }
  40.         if (!$firewallName) {
  41.             throw new InvalidArgumentException('$firewallName must not be empty.');
  42.         }
  44.         $this->setUser($user);
  45.     }
  47.     public function getFirewallName(): string
  48.     {
  49.         return $this->firewallName;
  50.     }
  52.     /**
  53.      * @deprecated since Symfony 7.2
  54.      */
  55.     public function getSecret(): string
  56.     {
  57.         trigger_deprecation('symfony/security-core', '7.2', 'The "%s()" method is deprecated.', __METHOD__);
  59.         return $this->secret ??= base64_encode(random_bytes(8));
  60.     }
  62.     public function __serialize(): array
  63.     {
  64.         // $this->firewallName should be kept at index 1 for compatibility with payloads generated before Symfony 8
  65.         return [$this->secret, $this->firewallName, parent::__serialize()];
  66.     }
  68.     public function __unserialize(array $data): void
  69.     {
  70.         [$this->secret, $this->firewallName, $parentData] = $data;
  71.         $parentData = \is_array($parentData) ? $parentData : unserialize($parentData);
  72.         parent::__unserialize($parentData);
  73.     }
  74. }