src/EventSubscriber/LocaleSubscriber.php line 65

  1. <?php
  3. namespace App\EventSubscriber;
  5. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  6. use Symfony\Component\HttpFoundation\RedirectResponse;
  7. use Symfony\Component\HttpKernel\Event\RequestEvent;
  8. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  9. use Symfony\Component\HttpKernel\KernelEvents;
  10. use Symfony\Component\Routing\RouteCollection;
  11. use Symfony\Component\Routing\RouterInterface;
  13. class LocaleSubscriber implements EventSubscriberInterface
  14. {
  15.     /**
  16.      * @var RouterInterface
  17.      */
  18.     private $router;
  20.     /**
  21.      * @var RouteCollection
  22.      */
  23.     private $routeCollection;
  25.     /**
  26.      * @var string
  27.      */
  28.     private $defaultLocale;
  30.     /**
  31.      * @var array
  32.      */
  33.     private $supportedLocales;
  35.     /**
  36.      * @var string
  37.      */
  38.     private $localeRouteParam;
  40.     /**
  41.      * @param RouterInterface $router
  42.      * @param $defaultLocale
  43.      * @param array $supportedLocales
  44.      */
  45.     public function __construct($defaultLocale, RouterInterface $router, array $supportedLocales = array('fr', 'en'), $localeRouteParam = '_locale')
  46.     {
  47.         $this->router = $router;
  48.         $this->routeCollection = $router->getRouteCollection();
  49.         $this->defaultLocale = $defaultLocale;
  50.         $this->supportedLocales = $supportedLocales;
  51.         $this->localeRouteParam = $localeRouteParam;
  52.     }
  54.     public function isLocaleSupported($locale)
  55.     {
  56.         return in_array($locale, $this->supportedLocales);
  57.     }
  59.     /**
  60.      * Redirect to correct locale route if omitted or not concordant with route requirements.
  61.      *
  62.      * @param ResponseEvent $event
  63.      * @return void
  64.      */
  65.     public function onKernelResponse(ResponseEvent $event): void
  66.     {
  67.         //--------------------------------------------------------------------------------------------------------------
  68.         // GOAL:
  69.         //--------------------------------------------------------------------------------------------------------------
  70.         // Redirect all incoming requests to their /locale/route equivalent as long as the route will exists when we do so.
  71.         // If the route required a specific locale so we force it.
  72.         // Do nothing if it already has /locale/ in the route to prevent redirect loops
  73.         //--------------------------------------------------------------------------------------------------------------
  75.         $request = $event->getRequest();
  76.         $path = $request->getPathInfo();
  77.         $pathWithoutLocale = null;
  79.         if (preg_match('#^/([a-zA-Z]{2,3})/#', $path, $parts)) {
  80.             $pathWithoutLocale = substr($path, strlen($parts[0]) -1);
  81.         }
  83.         $route_exists = false; // By default, assume route does not exist.
  84.         $force_locale = false; // By default, assume not forcing locale.
  87.         foreach ($this->routeCollection as $routeObject){
  88.             $routePath = $routeObject->getPath();
  90.             if ($routePath == '/{'.$this->localeRouteParam.'}'.$path || $routePath == '/{'.$this->localeRouteParam.'}'.$pathWithoutLocale){
  91.                 $route_requirements = $routeObject->getRequirements();
  92.                 $route_exists = true;
  94.                 // Checks if route has a required locale.
  95.                 if (is_array($route_requirements) && array_key_exists($this->localeRouteParam, $route_requirements)
  96.                     && !empty($route_requirements[$this->localeRouteParam])) {
  97.                     $routeLocales = explode('|', $route_requirements[$this->localeRouteParam]);
  98.                     $force_locale = count($routeLocales) > 1 ? false : $route_requirements[$this->localeRouteParam];
  99.                 }
  100.                 break;
  101.             }
  102.         }
  104.         // If the route does indeed exist then lets redirect there.
  105.         if ($route_exists == true){
  106.             // Get the locale from the users browser.
  107.             $locale = $request->getPreferredLanguage();
  109.             // If no locale from browser or locale not in list of known locales supported then set to defaultLocale.
  110.             if (!(!empty($locale) && $this->isLocaleSupported($locale) === true)) {
  111.                 $locale = $request->getDefaultLocale();
  112.             }
  114.             // If a locale was detected in route and current locale is different of required locale.
  115.             if(!is_bool($force_locale) && $locale !== $force_locale) {
  116.                 $locale = $force_locale;
  117.             }
  119.             $targeted_url = '/'.$locale.($pathWithoutLocale ?? $path);
  121.             if ($targeted_url === $path) {
  122.                 return;
  123.             }
  125.             $event->setResponse(new RedirectResponse($targeted_url));
  126.         }
  127.         elseif ($request->get($this->localeRouteParam) === null && $path === '/') 
  128.             $event->setResponse(new RedirectResponse('/'.$this->defaultLocale.'/'));
  129.         
  131.         //Otherwise do nothing and continue on~
  132.     }
  134.     public function onKernelRequest(RequestEvent $event): void
  135.     {
  136.         $request = $event->getRequest();
  138.         if (!$request->hasPreviousSession()) {
  139.             return;
  140.         }
  141.         // try to see if the locale has been set as a _locale routing parameter
  142.         if ($locale = $request->attributes->get($this->localeRouteParam)) {
  143.             $request->getSession()->set($this->localeRouteParam, $locale);
  144.         } else {
  145.             // if no explicit locale has been set on this request, use one from the session
  146.             $request->setLocale($request->getSession()->get($this->localeRouteParam, $this->defaultLocale));
  147.         }
  148.     }
  150.     public static function getSubscribedEvents()
  151.     {
  152.         return [
  153.             KernelEvents::RESPONSE => [['onKernelResponse', 17]],
  154.             // must be registered before (i.e. with a higher priority than) the default Locale listener
  155.             KernelEvents::REQUEST => [['onKernelRequest', 20]],
  156.         ];
  157.     }
  158. }