src/EventSubscriber/LocaleSubscriber.php line 21

Open in your IDE?
  1. <?php
  3. namespace App\EventSubscriber;
  5. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  6. use Symfony\Component\HttpKernel\Event\RequestEvent;
  7. use Symfony\Component\HttpKernel\KernelEvents;
  8. /**
  9.  * Based on https://symfony.com/doc/4.4/session/locale_sticky_session.html
  10.  * 
  11.  * 
  12.  */
  13. class LocaleSubscriber implements EventSubscriberInterface {
  15.     private $defaultLocale;
  17.     public function __construct($defaultLocale = 'es') {
  18.         $this->defaultLocale = $defaultLocale;
  19.     }
  21.     public function onKernelRequest(RequestEvent $event) {
  22.         $request = $event->getRequest();
  23.         if (!$request->hasPreviousSession()) {
  24.             return;
  25.         }
  27.         // try to get language from the HTTP_ACCEPT_LANGUAGE
  28.         $locale = $this->detect($request);
  29.         if ($locale) {
  30.             $request->getSession()->set('_locale', $locale);
  31.         }
  33.         //Retrieve locale value from session, if not, the default will be used
  34.         $request->setLocale($request->getSession()->get('_locale', $this->defaultLocale));
  35.         setLocale(LC_TIME, $request->getSession()->get('_locale', $this->defaultLocale));
  36.     }
  38.     /**
  39.      * 
  40.      * @return type
  41.      */
  42.     public static function getSubscribedEvents(): array {
  43.         return [
  44.             // must be registered before (i.e. with a higher priority than) the default Locale listener
  45.             KernelEvents::REQUEST => [['onKernelRequest', 20]],
  46.         ];
  47.     }
  48.     
  49.     /**
  50.      * Copied and adapted from golfandalucia.com
  51.      * 
  52.      * @param type $request
  53.      * @return type
  54.      */
  55.     private function detect($request): string {
  56.         $httpAcceptLanguageHeader = $this->getHttpAcceptLanguageHeader($request);
  58.         if ($httpAcceptLanguageHeader == null) {
  59.             return 'es';
  60.         }
  62.         $locales = $this->getWeightedLocales($httpAcceptLanguageHeader);
  64.         $sortedLocales = $this->sortLocalesByWeight($locales);
  66.         $mappedLocales = array_map(function ($weightedLocale) {
  67.             return $weightedLocale['locale'];
  68.         }, $sortedLocales);
  69.         
  70.         return (str_contains($mappedLocales[0], 'es')) ? 'es' : 'en';
  71.     }
  73.     private function getHttpAcceptLanguageHeader($request) {
  74.         if (null !== ($request->server->get('HTTP_ACCEPT_LANGUAGE'))) {
  75.             return trim($request->server->get('HTTP_ACCEPT_LANGUAGE'));
  76.         } else {
  77.             return null;
  78.         }
  79.     }
  81.     private function getWeightedLocales($httpAcceptLanguageHeader) {
  82.         if (strlen($httpAcceptLanguageHeader) == 0) {
  83.             return [];
  84.         }
  86.         $weightedLocales = [];
  88.         // We break up the string 'en-CA,ar-EG;q=0.5' along the commas,
  89.         // and iterate over the resulting array of individual locales. Once
  90.         // we're done, $weightedLocales should look like
  91.         // [['locale' => 'en-CA', 'q' => 1.0], ['locale' => 'ar-EG', 'q' => 0.5]]
  92.         foreach (explode(',', $httpAcceptLanguageHeader) as $locale) {
  93.             // separate the locale key ("ar-EG") from its weight ("q=0.5")
  94.             $localeParts = explode(';', $locale);
  96.             $weightedLocale = ['locale' => $localeParts[0]];
  98.             if (count($localeParts) == 2) {
  99.                 // explicit weight e.g. 'q=0.5'
  100.                 $weightParts = explode('=', $localeParts[1]);
  102.                 // grab the '0.5' bit and parse it to a float
  103.                 $weightedLocale['q'] = floatval($weightParts[1]);
  104.             } else {
  105.                 // no weight given in string, ie. implicit weight of 'q=1.0'
  106.                 $weightedLocale['q'] = 1.0;
  107.             }
  109.             $weightedLocales[] = $weightedLocale;
  110.         }
  112.         return $weightedLocales;
  113.     }
  115.     /**
  116.      * Sort by high to low `q` value
  117.      */
  118.     private function sortLocalesByWeight($locales) {
  119.         usort($locales, function ($a, $b) {
  120.             // usort will cast float values that we return here into integers,
  121.             // which can mess up our sorting. So instead of subtracting the `q`,
  122.             // values and returning the difference, we compare the `q` values and
  123.             // explicitly return integer values.
  124.             if ($a['q'] == $b['q']) {
  125.                 return 0;
  126.             }
  128.             if ($a['q'] > $b['q']) {
  129.                 return -1;
  130.             }
  132.             return 1;
  133.         });
  135.         return $locales;
  136.     }
  138. }