vendor/symfony/security-http/Authenticator/Passport/Badge/RememberMeBadge.php line 27

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\Http\Authenticator\Passport\Badge;
  14. use Symfony\Component\Security\Http\EventListener\CheckRememberMeConditionsListener;
  16. /**
  17. * Adds support for remember me to this authenticator.
  18. *
  19. * The presence of this badge doesn't create the remember-me cookie. The actual
  20. * cookie is only created if this badge is enabled. By default, this is done
  21. * by the {@see CheckRememberMeConditionsListener} if all conditions are met.
  22. *
  23. * @author Wouter de Jong <wouter@wouterj.nl>
  24. *
  25. * @final
  26. */
  27. class RememberMeBadge implements BadgeInterface
  28. {
  29. private $enabled = false;
  31. /**
  32. * Enables remember-me cookie creation.
  33. *
  34. * In most cases, {@see CheckRememberMeConditionsListener} enables this
  35. * automatically if always_remember_me is true or the remember_me_parameter
  36. * exists in the request.
  37. *
  38. * @return $this
  39. */
  40. public function enable(): self
  41. {
  42. $this->enabled = true;
  44. return $this;
  45. }
  47. /**
  48. * Disables remember-me cookie creation.
  49. *
  50. * The default is disabled, this can be called to suppress creation
  51. * after it was enabled.
  52. *
  53. * @return $this
  54. */
  55. public function disable(): self
  56. {
  57. $this->enabled = false;
  59. return $this;
  60. }
  62. public function isEnabled(): bool
  63. {
  64. return $this->enabled;
  65. }
  67. public function isResolved(): bool
  68. {
  69. return true; // remember me does not need to be explicitly resolved
  70. }
  71. }