vendor/symfony/security-core/Authentication/Token/UsernamePasswordToken.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. * UsernamePasswordToken implements a username and password token.
  18. *
  19. * @author Fabien Potencier <fabien@symfony.com>
  20. */
  21. class UsernamePasswordToken extends AbstractToken
  22. {
  23. private $credentials;
  24. private $firewallName;
  26. /**
  27. * @param UserInterface $user
  28. * @param string[] $roles
  29. *
  30. * @throws \InvalidArgumentException
  31. */
  32. public function __construct($user, /* string */ $firewallName, /* array */ $roles = [])
  33. {
  34. if (\is_string($roles)) {
  35. trigger_deprecation('symfony/security-core', '5.4', 'The $credentials argument of "%s" is deprecated.', static::class.'::__construct');
  37. $credentials = $firewallName;
  38. $firewallName = $roles;
  39. $roles = \func_num_args() > 3 ? func_get_arg(3) : [];
  40. }
  42. parent::__construct($roles);
  44. if ('' === $firewallName) {
  45. throw new \InvalidArgumentException('$firewallName must not be empty.');
  46. }
  48. $this->setUser($user);
  49. $this->credentials = $credentials ?? null;
  50. $this->firewallName = $firewallName;
  52. parent::setAuthenticated(\count($roles) > 0, false);
  53. }
  55. /**
  56. * {@inheritdoc}
  57. */
  58. public function setAuthenticated(bool $isAuthenticated)
  59. {
  60. if ($isAuthenticated) {
  61. throw new \LogicException('Cannot set this token to trusted after instantiation.');
  62. }
  64. parent::setAuthenticated(false, false);
  65. }
  67. /**
  68. * {@inheritdoc}
  69. */
  70. public function getCredentials()
  71. {
  72. trigger_deprecation('symfony/security-core', '5.4', 'Method "%s" is deprecated.', __METHOD__);
  74. return $this->credentials;
  75. }
  77. /**
  78. * Returns the provider key.
  79. *
  80. * @return string The provider key
  81. *
  82. * @deprecated since Symfony 5.2, use getFirewallName() instead
  83. */
  84. public function getProviderKey()
  85. {
  86. if (1 !== \func_num_args() || true !== func_get_arg(0)) {
  87. trigger_deprecation('symfony/security-core', '5.2', 'Method "%s" is deprecated, use "getFirewallName()" instead.', __METHOD__);
  88. }
  90. return $this->firewallName;
  91. }
  93. public function getFirewallName(): string
  94. {
  95. return $this->getProviderKey(true);
  96. }
  98. /**
  99. * {@inheritdoc}
  100. */
  101. public function eraseCredentials()
  102. {
  103. parent::eraseCredentials();
  105. $this->credentials = null;
  106. }
  108. /**
  109. * {@inheritdoc}
  110. */
  111. public function __serialize(): array
  112. {
  113. return [$this->credentials, $this->firewallName, parent::__serialize()];
  114. }
  116. /**
  117. * {@inheritdoc}
  118. */
  119. public function __unserialize(array $data): void
  120. {
  121. [$this->credentials, $this->firewallName, $parentData] = $data;
  122. $parentData = \is_array($parentData) ? $parentData : unserialize($parentData);
  123. parent::__unserialize($parentData);
  124. }
  125. }