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

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. trigger_deprecation('symfony/security-guard', '5.3', 'The "%s" class is deprecated, use the new authenticator system instead.', PostAuthenticationGuardToken::class);
  19. /**
  20. * Used as an "authenticated" token, though it could be set to not-authenticated later.
  21. *
  22. * If you're using Guard authentication, you *must* use a class that implements
  23. * GuardTokenInterface as your authenticated token (like this class).
  24. *
  25. * @author Ryan Weaver <ryan@knpuniversity.com>
  26. *
  27. * @deprecated since Symfony 5.3, use the new authenticator system instead
  28. */
  29. class PostAuthenticationGuardToken extends AbstractToken implements GuardTokenInterface
  30. {
  31. private $providerKey;
  33. /**
  34. * @param string $providerKey The provider (firewall) key
  35. * @param string[] $roles An array of roles
  36. *
  37. * @throws \InvalidArgumentException
  38. */
  39. public function __construct(UserInterface $user, string $providerKey, array $roles)
  40. {
  41. parent::__construct($roles);
  43. if (empty($providerKey)) {
  44. throw new \InvalidArgumentException('$providerKey (i.e. firewall key) must not be empty.');
  45. }
  47. $this->setUser($user);
  48. $this->providerKey = $providerKey;
  50. // this token is meant to be used after authentication success, so it is always authenticated
  51. // you could set it as non authenticated later if you need to
  52. $this->setAuthenticated(true, false);
  53. }
  55. /**
  56. * This is meant to be only an authenticated token, where credentials
  57. * have already been used and are thus cleared.
  58. *
  59. * {@inheritdoc}
  60. */
  61. public function getCredentials()
  62. {
  63. return [];
  64. }
  66. /**
  67. * Returns the provider (firewall) key.
  68. *
  69. * @return string
  70. */
  71. public function getProviderKey()
  72. {
  73. return $this->providerKey;
  74. }
  76. public function getFirewallName(): string
  77. {
  78. return $this->getProviderKey();
  79. }
  81. /**
  82. * {@inheritdoc}
  83. */
  84. public function __serialize(): array
  85. {
  86. return [$this->providerKey, parent::__serialize()];
  87. }
  89. /**
  90. * {@inheritdoc}
  91. */
  92. public function __unserialize(array $data): void
  93. {
  94. [$this->providerKey, $parentData] = $data;
  95. $parentData = \is_array($parentData) ? $parentData : unserialize($parentData);
  96. parent::__unserialize($parentData);
  97. }
  98. }