vendor/symfony/security-http/RememberMe/RememberMeServicesInterface.php line 18

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\RememberMe;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\HttpFoundation\Response;
  16. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  18. trigger_deprecation('symfony/security-http', '5.4', 'The "%s" interface is deprecated, use "%s" instead.', RememberMeServicesInterface::class, RememberMeHandlerInterface::class);
  20. /**
  21. * Interface that needs to be implemented by classes which provide remember-me
  22. * capabilities.
  23. *
  24. * We provide two implementations out-of-the-box:
  25. * - TokenBasedRememberMeServices (does not require a TokenProvider)
  26. * - PersistentTokenBasedRememberMeServices (requires a TokenProvider)
  27. *
  28. * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  29. *
  30. * @method logout(Request $request, Response $response, TokenInterface $token)
  31. *
  32. * @deprecated since Symfony 5.4, use {@see RememberMeHandlerInterface} instead
  33. */
  34. interface RememberMeServicesInterface
  35. {
  36. /**
  37. * This attribute name can be used by the implementation if it needs to set
  38. * a cookie on the Request when there is no actual Response, yet.
  39. */
  40. public const COOKIE_ATTR_NAME = '_security_remember_me_cookie';
  42. /**
  43. * This method will be called whenever the TokenStorage does not contain
  44. * a TokenInterface object and the framework wishes to provide an implementation
  45. * with an opportunity to authenticate the request using remember-me capabilities.
  46. *
  47. * No attempt whatsoever is made to determine whether the browser has requested
  48. * remember-me services or presented a valid cookie. Any and all such determinations
  49. * are left to the implementation of this method.
  50. *
  51. * If a browser has presented an unauthorised cookie for whatever reason,
  52. * make sure to throw an AuthenticationException as this will consequentially
  53. * result in a call to loginFail() and therefore an invalidation of the cookie.
  54. *
  55. * @return TokenInterface|null
  56. */
  57. public function autoLogin(Request $request);
  59. /**
  60. * Called whenever an interactive authentication attempt was made, but the
  61. * credentials supplied by the user were missing or otherwise invalid.
  62. *
  63. * This method needs to take care of invalidating the cookie.
  64. */
  65. public function loginFail(Request $request, ?\Exception $exception = null);
  67. /**
  68. * Called whenever an interactive authentication attempt is successful
  69. * (e.g. a form login).
  70. *
  71. * An implementation may always set a remember-me cookie in the Response,
  72. * although this is not recommended.
  73. *
  74. * Instead, implementations should typically look for a request parameter
  75. * (such as an HTTP POST parameter) that indicates the browser has explicitly
  76. * requested for the authentication to be remembered.
  77. */
  78. public function loginSuccess(Request $request, Response $response, TokenInterface $token);
  79. }