src/EventSubscriber/Api/UserLocaleSubscriber.php line 81

Open in your IDE?
  1. <?php
  3. namespace App\EventSubscriber\Api;
  5. use App\Entity\Api\CoreModule\User;
  6. use App\Helper\Api\JsonFormatter\Throwable\Formatter;
  7. use App\Helper\Api\Translator\ApiTranslator;
  8. use Symfony\Component\HttpFoundation\RequestStack;
  9. use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken;
  10. use Symfony\Component\Security\Http\Event\InteractiveLoginEvent;
  11. use Symfony\Component\Security\Http\SecurityEvents;
  13. /**
  14.  * Subscriber to store locale from user options in session after user logged in.
  15.  *
  16.  * @package API
  17.  * @api
  18.  */
  19. class UserLocaleSubscriber extends AbstractSubscriber
  20. {
  22.     /**
  23.      * Stack that controls the lifecycle of requests
  24.      *
  25.      * @var RequestStack
  26.      */
  27.     protected RequestStack $requestStack;
  29.     /**
  30.      * Returns an array of event names this subscriber wants to listen to.
  31.      *
  32.      * The array keys are event names and the value can be:
  33.      *
  34.      *  * The method name to call (priority defaults to 0)
  35.      *  * An array composed of the method name to call and the priority
  36.      *  * An array of arrays composed of the method names to call and respective
  37.      *    priorities, or 0 if unset
  38.      *
  39.      * For instance:
  40.      *
  41.      *  * ['eventName' => 'methodName']
  42.      *  * ['eventName' => ['methodName', $priority]]
  43.      *  * ['eventName' => [['methodName1', $priority], ['methodName2']]]
  44.      *
  45.      * The code must not depend on runtime state as it will only be called at compile time.
  46.      * All logic depending on runtime state must be put into the individual methods handling the events.
  47.      *
  48.      * @noinspection PhpArrayShapeAttributeCanBeAddedInspection
  49.      * @noinspection PhpUnused
  50.      */
  51.     public static function getSubscribedEvents(): array
  52.     {
  53.         return [
  54.             SecurityEvents::INTERACTIVE_LOGIN => [
  55.                 ['onInteractiveLogin', 0]
  56.             ]
  57.         ];
  58.     }
  60.     /**
  61.      * Constructor.
  62.      *
  63.      * @param Formatter $formatter
  64.      * @param ApiTranslator $translator
  65.      * @param RequestStack $requestStack
  66.      * @noinspection PhpPureAttributeCanBeAddedInspection
  67.      */
  68.     public function __construct(Formatter $formatter, ApiTranslator $translator, RequestStack $requestStack)
  69.     {
  70.         parent::__construct($formatter, $translator);
  71.         $this->requestStack = $requestStack;
  72.     }
  74.     /**
  75.      * Store locale from user options in session after user logged in.
  76.      *
  77.      * @param InteractiveLoginEvent $event
  78.      * @return void
  79.      * @noinspection PhpUnused
  80.      */
  81.     public function onInteractiveLogin(InteractiveLoginEvent $event): void
  82.     {
  83.         $token = $event->getAuthenticationToken();
  84.         /* @var UsernamePasswordToken $token */
  85.         // only handle for API routes and main firewall
  86.         if (preg_match('/^\/api\//', $event->getRequest()->getRequestUri()) &&
  87.             $token->getFirewallName() === 'main') {
  88.             $user = $token->getUser();
  89.             /* @var User $user */
  90.             $this->requestStack->getSession()->set('_locale', $user->getLocale());
  91.         }
  92.     }
  94. }