vendor/symfony/security-http/EventListener/RememberMeLogoutListener.php line 19

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\EventListener;
  14. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  15. use Symfony\Component\Security\Core\Exception\LogicException;
  16. use Symfony\Component\Security\Http\Event\LogoutEvent;
  17. use Symfony\Component\Security\Http\RememberMe\RememberMeServicesInterface;
  19. trigger_deprecation('symfony/security-http', '5.4', 'The "%s" class is deprecated.', RememberMeLogoutListener::class);
  21. /**
  22. * @author Wouter de Jong <wouter@wouterj.nl>
  23. *
  24. * @final
  25. *
  26. * @deprecated since Symfony 5.4
  27. */
  28. class RememberMeLogoutListener implements EventSubscriberInterface
  29. {
  30. private $rememberMeServices;
  32. public function __construct(RememberMeServicesInterface $rememberMeServices)
  33. {
  34. if (!method_exists($rememberMeServices, 'logout')) {
  35. trigger_deprecation('symfony/security-core', '5.1', '"%s" should implement the "logout(Request $request, Response $response, TokenInterface $token)" method, this method will be added to the "%s" in version 6.0.', \get_class($rememberMeServices), RememberMeServicesInterface::class);
  36. }
  38. $this->rememberMeServices = $rememberMeServices;
  39. }
  41. public function onLogout(LogoutEvent $event): void
  42. {
  43. if (!method_exists($this->rememberMeServices, 'logout')) {
  44. return;
  45. }
  47. if (!$event->getToken()) {
  48. return;
  49. }
  51. if (null === $event->getResponse()) {
  52. throw new LogicException(sprintf('No response was set for this logout action. Make sure the DefaultLogoutListener or another listener has set the response before "%s" is called.', __CLASS__));
  53. }
  55. $this->rememberMeServices->logout($event->getRequest(), $event->getResponse(), $event->getToken());
  56. }
  58. public static function getSubscribedEvents(): array
  59. {
  60. return [
  61. LogoutEvent::class => 'onLogout',
  62. ];
  63. }
  64. }