src/EventSubscriber/Api/LogoutSubscriber.php line 60

Open in your IDE?
  1. <?php
  3. namespace App\EventSubscriber\Api;
  5. use App\Controller\Api\AbstractApiController;
  6. use App\Helper\Api\Entity\JsonResponseDataContainer;
  7. use Symfony\Component\HttpFoundation\JsonResponse;
  8. use Symfony\Component\HttpFoundation\Response;
  9. use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken;
  10. use Symfony\Component\Security\Http\Event\LogoutEvent;
  12. /**
  13.  * Returns response after successful logout
  14.  *
  15.  * @package API
  16.  * @api
  17.  */
  18. class LogoutSubscriber extends AbstractSubscriber
  19. {
  21.     /**
  22.      * Returns an array of event names this subscriber wants to listen to.
  23.      *
  24.      * The array keys are event names and the value can be:
  25.      *
  26.      *  * The method name to call (priority defaults to 0)
  27.      *  * An array composed of the method name to call and the priority
  28.      *  * An array of arrays composed of the method names to call and respective
  29.      *    priorities, or 0 if unset
  30.      *
  31.      * For instance:
  32.      *
  33.      *  * ['eventName' => 'methodName']
  34.      *  * ['eventName' => ['methodName', $priority]]
  35.      *  * ['eventName' => [['methodName1', $priority], ['methodName2']]]
  36.      *
  37.      * The code must not depend on runtime state as it will only be called at compile time.
  38.      * All logic depending on runtime state must be put into the individual methods handling the events.
  39.      *
  40.      * @noinspection PhpArrayShapeAttributeCanBeAddedInspection
  41.      * @noinspection PhpUnused
  42.      */
  43.     public static function getSubscribedEvents(): array
  44.     {
  45.         return [
  46.             LogoutEvent::class => [
  47.                 ['onLogout', 0]
  48.             ]
  49.         ];
  50.     }
  52.     /**
  53.      * Creates a JsonResponse when logout event is dispatched.
  54.      *
  55.      * @param LogoutEvent $event Logout event.
  56.      * @return void
  57.      * @noinspection PhpUnused
  58.      * @api
  59.      */
  60.     public function onLogout(LogoutEvent $event): void
  61.     {
  62.         $token = $event->getToken();
  63.         /* @var UsernamePasswordToken $token */
  64.         // only handle for API routes and main firewall
  65.         if (preg_match('/^\/api\//', $event->getRequest()->getRequestUri()) &&
  66.             $token->getFirewallName() === 'main') {
  67.             $container = new JsonResponseDataContainer();
  68.             $container->addData(
  69.                 [AbstractApiController::JSON_RESPONSE_PARAMETER_NAME_MESSAGE => $this->t('logout.successful')]
  70.             );
  71.             $event->setResponse(new JsonResponse($container->getJsonString(), Response::HTTP_OK, [], true));
  72.         }
  73.     }
  75. }