vendor/symfony/security-guard/Token/PostAuthenticationGuardToken.php line 25

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\Guard\Token;
  14. use Symfony\Component\Security\Core\Authentication\Token\AbstractToken;
  15. use Symfony\Component\Security\Core\User\UserInterface;
  17. /**
  18.  * Used as an "authenticated" token, though it could be set to not-authenticated later.
  19.  *
  20.  * If you're using Guard authentication, you *must* use a class that implements
  21.  * GuardTokenInterface as your authenticated token (like this class).
  22.  *
  23.  * @author Ryan Weaver <ryan@knpuniversity.com>
  24.  */
  25. class PostAuthenticationGuardToken extends AbstractToken implements GuardTokenInterface
  26. {
  27.     private $providerKey;
  29.     /**
  30.      * @param UserInterface $user        The user!
  31.      * @param string        $providerKey The provider (firewall) key
  32.      * @param string[]      $roles       An array of roles
  33.      *
  34.      * @throws \InvalidArgumentException
  35.      */
  36.     public function __construct(UserInterface $user, string $providerKey, array $roles)
  37.     {
  38.         parent::__construct($roles);
  40.         if (empty($providerKey)) {
  41.             throw new \InvalidArgumentException('$providerKey (i.e. firewall key) must not be empty.');
  42.         }
  44.         $this->setUser($user);
  45.         $this->providerKey = $providerKey;
  47.         // this token is meant to be used after authentication success, so it is always authenticated
  48.         // you could set it as non authenticated later if you need to
  49.         $this->setAuthenticated(true);
  50.     }
  52.     /**
  53.      * This is meant to be only an authenticated token, where credentials
  54.      * have already been used and are thus cleared.
  55.      *
  56.      * {@inheritdoc}
  57.      */
  58.     public function getCredentials()
  59.     {
  60.         return [];
  61.     }
  63.     /**
  64.      * Returns the provider (firewall) key.
  65.      *
  66.      * @return string
  67.      */
  68.     public function getProviderKey()
  69.     {
  70.         return $this->providerKey;
  71.     }
  73.     /**
  74.      * {@inheritdoc}
  75.      */
  76.     public function __serialize(): array
  77.     {
  78.         return [$this->providerKey, parent::__serialize()];
  79.     }
  81.     /**
  82.      * {@inheritdoc}
  83.      */
  84.     public function __unserialize(array $data): void
  85.     {
  86.         [$this->providerKey, $parentData] = $data;
  87.         parent::__unserialize($parentData);
  88.     }
  89. }