src/EventSubscriber/Api/LocaleSubscriber.php line 62

Open in your IDE?
  1. <?php
  3. namespace App\EventSubscriber\Api;
  5. use Symfony\Component\HttpKernel\Event\RequestEvent;
  6. use Symfony\Component\HttpKernel\KernelEvents;
  8. /**
  9.  * Subscriber to set locale to session from explicit routing parameter or restore locale from previous session.
  10.  *
  11.  * @package API
  12.  * @internal
  13.  */
  14. class LocaleSubscriber extends AbstractSubscriber
  15. {
  17.     /**
  18.      * Key for locale configuration in Symfony session.
  19.      */
  20.     const SYMFONY_SESSION_LOCALE_KEY = '_locale';
  22.     /**
  23.      * Returns an array of event names this subscriber wants to listen to.
  24.      *
  25.      * The array keys are event names and the value can be:
  26.      *
  27.      *  * The method name to call (priority defaults to 0)
  28.      *  * An array composed of the method name to call and the priority
  29.      *  * An array of arrays composed of the method names to call and respective
  30.      *    priorities, or 0 if unset
  31.      *
  32.      * For instance:
  33.      *
  34.      *  * ['eventName' => 'methodName']
  35.      *  * ['eventName' => ['methodName', $priority]]
  36.      *  * ['eventName' => [['methodName1', $priority], ['methodName2']]]
  37.      *
  38.      * The code must not depend on runtime state as it will only be called at compile time.
  39.      * All logic depending on runtime state must be put into the individual methods handling the events.
  40.      *
  41.      * @noinspection PhpArrayShapeAttributeCanBeAddedInspection
  42.      * @noinspection PhpUnused
  43.      */
  44.     public static function getSubscribedEvents(): array
  45.     {
  46.         return [
  47.             // must be registered before (i.e. with a higher priority than) the default Locale listener (currently 16 by
  48.             // bin/console debug:event)
  49.             KernelEvents::REQUEST => [
  50.                 ['onKernelRequest', 20]
  51.             ]
  52.         ];
  53.     }
  55.     /**
  56.      * Set locale to session from explicit routing parameter or restore locale from previous session.
  57.      *
  58.      * @param RequestEvent $event
  59.      * @return void
  60.      * @noinspection PhpUnused
  61.      */
  62.     public function onKernelRequest(RequestEvent $event): void
  63.     {
  64.         /** only handle API routes and ignore the login route (handled by @link UserLocaleSubscriber) */
  65.         if (preg_match('/^\/api\//', $event->getRequest()->getRequestUri()) &&
  66.             preg_match('/^\/api\/[a-z]{2}\/login$/', $event->getRequest()->getRequestUri()) != 1) {
  67.             $request = $event->getRequest();
  68.             // be more efficient
  69.             if (!$request->hasPreviousSession()) {
  70.                 return;
  71.             }
  72.             // try to see if the locale has been set as a _locale routing parameter
  73.             if ($locale = $request->attributes->get(static::SYMFONY_SESSION_LOCALE_KEY)) {
  74.                 // store explicit routing parameter in the session
  75.                 $request->getSession()->set(static::SYMFONY_SESSION_LOCALE_KEY, $locale);
  76.             } else {
  77.                 // if no explicit locale has been set on this request, use one from the session
  78.                 $request->setLocale(
  79.                     $request->getSession()->get(
  80.                         static::SYMFONY_SESSION_LOCALE_KEY,
  81.                         $_ENV['MANDATORY_TRANSLATION_LOCALE']
  82.                     )
  83.                 );
  84.             }
  85.         }
  86.     }
  88. }