vendor/presta/sitemap-bundle/src/EventListener/StaticRoutesAlternateEventListener.php line 62

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the PrestaSitemapBundle package.
  5.  *
  6.  * (c) PrestaConcept <https://prestaconcept.net>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Presta\SitemapBundle\EventListener;
  14. use Presta\SitemapBundle\Event\SitemapAddUrlEvent;
  15. use Presta\SitemapBundle\Sitemap\Url\GoogleMultilangUrlDecorator;
  16. use Presta\SitemapBundle\Sitemap\Url\UrlConcrete;
  17. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  18. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  20. /**
  21.  * Listen to "presta_sitemap.add_url" event.
  22.  * Decorate translatable Url with multi-lang alternatives.
  23.  * Support both Symfony translated routes & JMSI18nRoutingBundle.
  24.  */
  25. final class StaticRoutesAlternateEventListener implements EventSubscriberInterface
  26. {
  27.     private const TRANSLATED_ROUTE_NAME_STRATEGIES = [
  28.         'symfony' => '/^(?P<name>.+)\.(?P<locale>%locales%)$/',
  29.         'jms' => '/^(?P<locale>%locales%)__RG__(?P<name>.+)$/',
  30.     ];
  32.     /**
  33.      * @var UrlGeneratorInterface
  34.      */
  35.     private $router;
  37.     /**
  38.      * @var array<string, mixed>
  39.      */
  40.     private $options;
  42.     /**
  43.      * @param UrlGeneratorInterface $router
  44.      * @param array<string, mixed>  $options
  45.      */
  46.     public function __construct(UrlGeneratorInterface $router, array $options)
  47.     {
  48.         $this->router = $router;
  49.         $this->options = $options;
  50.     }
  52.     /**
  53.      * @inheritdoc
  54.      */
  55.     public static function getSubscribedEvents(): array
  56.     {
  57.         return [
  58.             SitemapAddUrlEvent::class => 'addAlternate',
  59.         ];
  60.     }
  62.     public function addAlternate(SitemapAddUrlEvent $event): void
  63.     {
  64.         $name = $event->getRoute();
  65.         $options = $event->getOptions();
  67.         $info = $this->getTranslatedRouteInfo($name);
  68.         if ($info === null) {
  69.             return; // not a supported translated route
  70.         }
  72.         [$translatedName, $locale] = $info;
  74.         if ($locale !== $this->options['default_locale']) {
  75.             // route is translated, but we are on the non default locale route, should be skipped
  76.             $event->preventRegistration();
  78.             return;
  79.         }
  81.         $url = new GoogleMultilangUrlDecorator(
  82.             new UrlConcrete(
  83.                 $this->generateTranslatedRouteUrl($translatedName, $locale),
  84.                 $options['lastmod'],
  85.                 $options['changefreq'],
  86.                 $options['priority']
  87.             )
  88.         );
  89.         foreach ($this->options['locales'] as $alternate) {
  90.             $url->addLink($this->generateTranslatedRouteUrl($translatedName, $alternate), $alternate);
  91.         }
  93.         $event->setUrl($url);
  94.     }
  96.     /**
  97.      * @param string $name
  98.      *
  99.      * @return array{0: string, 1: string}|null
  100.      */
  101.     private function getTranslatedRouteInfo(string $name): ?array
  102.     {
  103.         $pattern = self::TRANSLATED_ROUTE_NAME_STRATEGIES[$this->options['i18n']] ?? '';
  104.         $pattern = \str_replace('%locales%', \implode('|', $this->options['locales']), $pattern);
  106.         if (!\preg_match($pattern, $name, $matches)) {
  107.             return null; // route name do not match translated route name pattern, skip
  108.         }
  110.         return [$matches['name'], $matches['locale']];
  111.     }
  113.     private function generateTranslatedRouteUrl(string $name, string $locale): string
  114.     {
  115.         return $this->router->generate($name, ['_locale' => $locale], UrlGeneratorInterface::ABSOLUTE_URL);
  116.     }
  117. }