vendor/ibexa/admin-ui/src/lib/EventListener/RequestLocaleListener.php line 74

Open in your IDE?
  1. <?php
  3. /**
  4.  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  5.  * @license For full copyright and license information view LICENSE file distributed with this source code.
  6.  */
  7. declare(strict_types=1);
  9. namespace Ibexa\AdminUi\EventListener;
  11. use Ibexa\AdminUi\Specification\SiteAccess\IsAdmin;
  12. use Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface;
  13. use Ibexa\Core\MVC\Symfony\Locale\UserLanguagePreferenceProviderInterface;
  14. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpKernel\Event\RequestEvent;
  17. use Symfony\Component\HttpKernel\HttpKernelInterface;
  18. use Symfony\Component\HttpKernel\KernelEvents;
  19. use Symfony\Contracts\Translation\TranslatorInterface;
  21. class RequestLocaleListener implements EventSubscriberInterface
  22. {
  23.     /** @var array */
  24.     private $siteAccessGroups;
  26.     /** @var array */
  27.     private $availableTranslations;
  29.     /** @var \Symfony\Contracts\Translation\TranslatorInterface */
  30.     private $translator;
  32.     /** @var \Ibexa\Core\MVC\Symfony\Locale\UserLanguagePreferenceProviderInterface */
  33.     private $userLanguagePreferenceProvider;
  35.     /** @var \Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface */
  36.     private $configResolver;
  38.     /**
  39.      * @param array $siteAccessGroups
  40.      * @param array $availableTranslations
  41.      * @param \Symfony\Contracts\Translation\TranslatorInterface $translator
  42.      * @param \Ibexa\Core\MVC\Symfony\Locale\UserLanguagePreferenceProviderInterface $userLanguagePreferenceProvider
  43.      * @param \Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface $configResolver
  44.      */
  45.     public function __construct(
  46.         array $siteAccessGroups,
  47.         array $availableTranslations,
  48.         TranslatorInterface $translator,
  49.         UserLanguagePreferenceProviderInterface $userLanguagePreferenceProvider,
  50.         ConfigResolverInterface $configResolver
  51.     ) {
  52.         $this->siteAccessGroups = $siteAccessGroups;
  53.         $this->availableTranslations = $availableTranslations;
  54.         $this->translator = $translator;
  55.         $this->userLanguagePreferenceProvider = $userLanguagePreferenceProvider;
  56.         $this->configResolver = $configResolver;
  57.     }
  59.     /**
  60.      * {@inheritdoc}
  61.      */
  62.     public static function getSubscribedEvents(): array
  63.     {
  64.         return [
  65.             KernelEvents::REQUEST => ['onKernelRequest', 6],
  66.         ];
  67.     }
  69.     /**
  70.      * @param \Symfony\Component\HttpKernel\Event\RequestEvent $event
  71.      *
  72.      * @throws \Ibexa\AdminUi\Exception\InvalidArgumentException
  73.      */
  74.     public function onKernelRequest(RequestEvent $event): void
  75.     {
  76.         $request = $event->getRequest();
  78.         if (HttpKernelInterface::MASTER_REQUEST !== $event->getRequestType() || !$this->isAdminSiteAccess($request)) {
  79.             return;
  80.         }
  82.         $additionalTranslations = $this->configResolver->getParameter('user_preferences.additional_translations');
  83.         $preferableLocales = $this->userLanguagePreferenceProvider->getPreferredLocales($request);
  84.         $locale = null;
  86.         foreach ($preferableLocales as $preferableLocale) {
  87.             if (\in_array($preferableLocale, $this->availableTranslations, true)
  88.                 || \in_array($preferableLocale, $additionalTranslations, true)
  89.             ) {
  90.                 $locale = $preferableLocale;
  91.                 break;
  92.             }
  93.         }
  94.         $locale = $locale ?? reset($preferableLocales);
  95.         $request->setLocale($locale);
  96.         $request->attributes->set('_locale', $locale);
  97.         // Set of the current locale on the translator service is needed because RequestLocaleListener has lower
  98.         // priority than LocaleListener and messages are not translated on login, forgot and reset password pages.
  99.         $this->translator->setLocale($locale);
  100.     }
  102.     /**
  103.      * @param \Symfony\Component\HttpFoundation\Request $request
  104.      *
  105.      * @return bool
  106.      *
  107.      * @throws \Ibexa\AdminUi\Exception\InvalidArgumentException
  108.      */
  109.     protected function isAdminSiteAccess(Request $request): bool
  110.     {
  111.         return (new IsAdmin($this->siteAccessGroups))->isSatisfiedBy($request->attributes->get('siteaccess'));
  112.     }
  113. }
  115. class_alias(RequestLocaleListener::class, 'EzSystems\EzPlatformAdminUi\EventListener\RequestLocaleListener');