src/EventSubscriber/LocaleSubscriber.php line 65

Open in your IDE?
  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'), $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();
  78.         $route_exists = false; // By default, assume route does not exist.
  79.         $force_locale = false; // By default, assume not forcing locale.
  81.         foreach ($this->routeCollection as $routeObject){
  82.             $routePath = $routeObject->getPath();
  83.             if ($routePath == '/'.$this->localeRouteParam.$path){
  84.                 $route_requirements = $routeObject->getRequirements();
  85.                 $route_exists = true;
  87.                 // Checks if route has a required locale.
  88.                 if (is_array($route_requirements) && array_key_exists($this->localeRouteParam, $route_requirements)
  89.                     && !empty($route_requirements[$this->localeRouteParam])) {
  90.                     $force_locale = $route_requirements[$this->localeRouteParam];
  91.                 }
  92.                 break;
  93.             }
  94.         }
  96.         // If the route does indeed exist then lets redirect there.
  97.         if ($route_exists == true){
  98.             // Get the locale from the users browser.
  99.             $locale = $request->getPreferredLanguage();
  101.             // If no locale from browser or locale not in list of known locales supported then set to defaultLocale.
  102.             if (!(!empty($locale) && $this->isLocaleSupported($locale) === true)) {
  103.                 $locale = $request->getDefaultLocale();
  104.             }
  106.             // If a locale was detected in route and current locale is different of required locale.
  107.             if(!is_bool($force_locale) && $locale !== $force_locale) {
  108.                 $locale = $force_locale;
  109.             }
  111.             $event->setResponse(new RedirectResponse("/".$locale.$path));
  112.         }
  113.         elseif ($request->get($this->localeRouteParam) === null && $path === '/') 
  114.             $event->setResponse(new RedirectResponse('/'.$this->defaultLocale.'/'));
  115.         
  117.         //Otherwise do nothing and continue on~
  118.     }
  120.     public function onKernelRequest(RequestEvent $event): void
  121.     {
  122.         $request = $event->getRequest();
  124.         if (!$request->hasPreviousSession()) {
  125.             return;
  126.         }
  127.         // try to see if the locale has been set as a _locale routing parameter
  128.         if ($locale = $request->attributes->get($this->localeRouteParam)) {
  129.             $request->getSession()->set($this->localeRouteParam, $locale);
  130.         } else {
  131.             // if no explicit locale has been set on this request, use one from the session
  132.             $request->setLocale($request->getSession()->get($this->localeRouteParam, $this->defaultLocale));
  133.         }
  134.     }
  136.     public static function getSubscribedEvents()
  137.     {
  138.         return [
  139.             KernelEvents::RESPONSE => [['onKernelResponse', 17]],
  140.             // must be registered before (i.e. with a higher priority than) the default Locale listener
  141.             KernelEvents::REQUEST => [['onKernelRequest', 20]],
  142.         ];
  143.     }
  144. }