vendor/shopware/core/Content/Seo/HreflangLoader.php line 33

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Seo;
  5. use Doctrine\DBAL\ArrayParameterType;
  6. use Doctrine\DBAL\Connection;
  7. use Shopware\Core\Content\Seo\Hreflang\HreflangCollection;
  8. use Shopware\Core\Content\Seo\Hreflang\HreflangStruct;
  9. use Shopware\Core\Framework\Log\Package;
  10. use Shopware\Core\Framework\Uuid\Uuid;
  11. use Symfony\Component\Routing\RouterInterface;
  13. #[Package('sales-channel')]
  14. class HreflangLoader implements HreflangLoaderInterface
  15. {
  16.     /**
  17.      * @internal
  18.      */
  19.     public function __construct(
  20.         private readonly RouterInterface $router,
  21.         private readonly Connection $connection
  22.     ) {
  23.     }
  25.     public function load(HreflangLoaderParameter $parameter): HreflangCollection
  26.     {
  27.         $salesChannelContext = $parameter->getSalesChannelContext();
  29.         if (!$salesChannelContext->getSalesChannel()->isHreflangActive()) {
  30.             return new HreflangCollection();
  31.         }
  33.         $domains = $this->fetchSalesChannelDomains($salesChannelContext->getSalesChannel()->getId());
  35.         if ($parameter->getRoute() === 'frontend.home.page') {
  36.             return $this->getHreflangForHomepage($domains, $salesChannelContext->getSalesChannel()->getHreflangDefaultDomainId());
  37.         }
  39.         $pathInfo = $this->router->generate($parameter->getRoute(), $parameter->getRouteParameters(), RouterInterface::ABSOLUTE_PATH);
  41.         $languageToDomainMapping = $this->getLanguageToDomainMapping($domains);
  42.         $seoUrls = $this->fetchSeoUrls($pathInfo, $salesChannelContext->getSalesChannel()->getId(), array_keys($languageToDomainMapping));
  44.         // We need at least two links
  45.         if (\count($seoUrls) <= 1) {
  46.             return new HreflangCollection();
  47.         }
  49.         $hreflangCollection = new HreflangCollection();
  51.         /** @var array{seoPathInfo: string, languageId: string} $seoUrl */
  52.         foreach ($seoUrls as $seoUrl) {
  53.             /** @var array{languageId: string, id: string, url: string, locale: string, onlyLocale: bool} $domain */
  54.             foreach ($languageToDomainMapping[$seoUrl['languageId']] as $domain) {
  55.                 $this->addHreflangForDomain(
  56.                     $domain,
  57.                     $seoUrl,
  58.                     $salesChannelContext->getSalesChannel()->getHreflangDefaultDomainId(),
  59.                     $hreflangCollection
  60.                 );
  61.             }
  62.         }
  64.         return $hreflangCollection;
  65.     }
  67.     /**
  68.      * @param list<array{languageId: string, id: string, url: string, locale: string, onlyLocale: bool}> $domains
  69.      */
  70.     private function getHreflangForHomepage(array $domains, ?string $defaultDomainId): HreflangCollection
  71.     {
  72.         $collection = new HreflangCollection();
  74.         if (\count($domains) <= 1) {
  75.             return new HreflangCollection();
  76.         }
  78.         /** @var array{languageId: string, id: string, url: string, locale: string, onlyLocale: bool} $domain */
  79.         foreach ($domains as $domain) {
  80.             $this->addHreflangForDomain(
  81.                 $domain,
  82.                 null,
  83.                 $defaultDomainId,
  84.                 $collection
  85.             );
  86.         }
  88.         return $collection;
  89.     }
  91.     /**
  92.      * @return list<array{languageId: string, id: string, url: string, locale: string, onlyLocale: bool}>
  93.      */
  94.     private function fetchSalesChannelDomains(string $salesChannelId): array
  95.     {
  96.         /** @var list<array{languageId: string, id: string, url: string, locale: string, onlyLocale: bool}> $result */
  97.         $result = $this->connection->fetchAllAssociative(
  98.             'SELECT `domain`.`language_id` AS languageId,
  99.                           `domain`.`id` AS id,
  100.                           `domain`.`url` AS url,
  101.                           `domain`.`hreflang_use_only_locale` AS onlyLocale,
  102.                           `locale`.`code` AS locale
  103.             FROM `sales_channel_domain` AS `domain`
  104.             INNER JOIN `language` ON `language`.`id` = `domain`.`language_id`
  105.             INNER JOIN `locale` ON `locale`.`id` = `language`.`locale_id`
  106.             WHERE `domain`.`sales_channel_id` = :salesChannelId',
  107.             ['salesChannelId' => Uuid::fromHexToBytes($salesChannelId)]
  108.         );
  110.         return $result;
  111.     }
  113.     /**
  114.      * @param list<array{languageId: string, id: string, url: string, locale: string}> $domains
  115.      *
  116.      * @return array<string, list<array{languageId: string, id: string, url: string, locale: string}>>
  117.      */
  118.     private function getLanguageToDomainMapping(array $domains): array
  119.     {
  120.         $mapping = [];
  122.         foreach ($domains as $domain) {
  123.             $mapping[$domain['languageId']][] = $domain;
  124.         }
  126.         return $mapping;
  127.     }
  129.     /**
  130.      * @param array{languageId: string, id: string, url: string, locale: string, onlyLocale: bool} $domain
  131.      * @param array{seoPathInfo: string, languageId: string}|null $seoUrl
  132.      */
  133.     private function addHreflangForDomain(
  134.         array $domain,
  135.         ?array $seoUrl,
  136.         ?string $defaultDomainId,
  137.         HreflangCollection $collection
  138.     ): void {
  139.         $hrefLang = new HreflangStruct();
  141.         $hrefLang->setUrl($domain['url']);
  142.         if ($seoUrl) {
  143.             $hrefLang->setUrl($domain['url'] . '/' . $seoUrl['seoPathInfo']);
  144.         }
  145.         $locale = $domain['locale'];
  147.         if ($domain['onlyLocale']) {
  148.             $locale = mb_substr($locale, 0, 2);
  149.         }
  151.         if (Uuid::fromBytesToHex($domain['id']) === $defaultDomainId) {
  152.             $mainLang = clone $hrefLang;
  153.             $mainLang->setLocale('x-default');
  154.             $collection->add($mainLang);
  155.         }
  157.         $hrefLang->setLocale($locale);
  158.         $collection->add($hrefLang);
  159.     }
  161.     /**
  162.      * @param array<string> $languageIds
  163.      *
  164.      * @return list<array{seoPathInfo: string, languageId: string}>
  165.      */
  166.     private function fetchSeoUrls(string $pathInfo, string $salesChannelId, array $languageIds): array
  167.     {
  168.         /** @var list<array{seoPathInfo: string, languageId: string}> $result */
  169.         $result = $this->connection->fetchAllAssociative(
  170.             'SELECT `seo_path_info` AS seoPathInfo, `language_id` AS languageId
  171.             FROM `seo_url`
  172.             WHERE `path_info` = :pathInfo AND `is_canonical` = 1 AND
  173.                   `sales_channel_id` = :salesChannelId AND `language_id` IN (:languageIds)',
  174.             ['pathInfo' => $pathInfo, 'salesChannelId' => Uuid::fromHexToBytes($salesChannelId), 'languageIds' => $languageIds],
  175.             ['languageIds' => ArrayParameterType::STRING]
  176.         );
  178.         return $result;
  179.     }
  180. }