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 string   $providerKey The provider (firewall) key
  31.      * @param string[] $roles       An array of roles
  32.      *
  33.      * @throws \InvalidArgumentException
  34.      */
  35.     public function __construct(UserInterface $user, string $providerKey, array $roles)
  36.     {
  37.         parent::__construct($roles);
  39.         if (empty($providerKey)) {
  40.             throw new \InvalidArgumentException('$providerKey (i.e. firewall key) must not be empty.');
  41.         }
  43.         $this->setUser($user);
  44.         $this->providerKey = $providerKey;
  46.         // this token is meant to be used after authentication success, so it is always authenticated
  47.         // you could set it as non authenticated later if you need to
  48.         $this->setAuthenticated(true);
  49.     }
  51.     /**
  52.      * This is meant to be only an authenticated token, where credentials
  53.      * have already been used and are thus cleared.
  54.      *
  55.      * {@inheritdoc}
  56.      */
  57.     public function getCredentials()
  58.     {
  59.         return [];
  60.     }
  62.     /**
  63.      * Returns the provider (firewall) key.
  64.      *
  65.      * @return string
  66.      */
  67.     public function getProviderKey()
  68.     {
  69.         return $this->providerKey;
  70.     }
  72.     public function getFirewallName(): string
  73.     {
  74.         return $this->getProviderKey();
  75.     }
  77.     /**
  78.      * {@inheritdoc}
  79.      */
  80.     public function __serialize(): array
  81.     {
  82.         return [$this->providerKey, parent::__serialize()];
  83.     }
  85.     /**
  86.      * {@inheritdoc}
  87.      */
  88.     public function __unserialize(array $data): void
  89.     {
  90.         [$this->providerKey, $parentData] = $data;
  91.         $parentData = \is_array($parentData) ? $parentData : unserialize($parentData);
  92.         parent::__unserialize($parentData);
  93.     }
  94. }