vendor/symfony/security-guard/Token/PreAuthenticationGuardToken.php line 16

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the Symfony package.
  5. *
  6. * (c) Fabien Potencier <[email protected]>
  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;
  16. trigger_deprecation('symfony/security-guard', '5.3', 'The "%s" class is deprecated, use the new authenticator system instead.', PreAuthenticationGuardToken::class);
  18. /**
  19. * The token used by the guard auth system before authentication.
  20. *
  21. * The GuardAuthenticationListener creates this, which is then consumed
  22. * immediately by the GuardAuthenticationProvider. If authentication is
  23. * successful, a different authenticated token is returned
  24. *
  25. * @author Ryan Weaver <[email protected]>
  26. *
  27. * @deprecated since Symfony 5.3, use the new authenticator system instead
  28. */
  29. class PreAuthenticationGuardToken extends AbstractToken implements GuardTokenInterface
  30. {
  31. private $credentials;
  32. private $guardProviderKey;
  34. /**
  35. * @param mixed $credentials
  36. * @param string $guardProviderKey Unique key that bind this token to a specific AuthenticatorInterface
  37. */
  38. public function __construct($credentials, string $guardProviderKey)
  39. {
  40. $this->credentials = $credentials;
  41. $this->guardProviderKey = $guardProviderKey;
  43. parent::__construct([]);
  45. // @deprecated since Symfony 5.4
  46. parent::setAuthenticated(false);
  47. }
  49. public function getGuardProviderKey()
  50. {
  51. return $this->guardProviderKey;
  52. }
  54. /**
  55. * Returns the user credentials, which might be an array of anything you
  56. * wanted to put in there (e.g. username, password, favoriteColor).
  57. *
  58. * @return mixed
  59. */
  60. public function getCredentials()
  61. {
  62. return $this->credentials;
  63. }
  65. /**
  66. * @deprecated since Symfony 5.4
  67. */
  68. public function setAuthenticated(bool $authenticated)
  69. {
  70. throw new \LogicException('The PreAuthenticationGuardToken is *never* authenticated.');
  71. }
  72. }