src/Core/Content/Sitemap/Provider/CategoryUrlProvider.php line 50

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Sitemap\Provider;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Content\Category\CategoryDefinition;
  7. use Shopware\Core\Content\Category\CategoryEntity;
  8. use Shopware\Core\Content\Sitemap\Service\ConfigHandler;
  9. use Shopware\Core\Content\Sitemap\Struct\Url;
  10. use Shopware\Core\Content\Sitemap\Struct\UrlResult;
  11. use Shopware\Core\Defaults;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Dbal\Common\IteratorFactory;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Doctrine\FetchModeHelper;
  14. use Shopware\Core\Framework\Log\Package;
  15. use Shopware\Core\Framework\Plugin\Exception\DecorationPatternException;
  16. use Shopware\Core\Framework\Uuid\Uuid;
  17. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  18. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  19. use Symfony\Component\Routing\RouterInterface;
  21. #[Package('sales-channel')]
  22. class CategoryUrlProvider extends AbstractUrlProvider
  23. {
  24.     final public const CHANGE_FREQ = 'daily';
  26.     /**
  27.      * @internal
  28.      */
  29.     public function __construct(private readonly ConfigHandler $configHandler, private readonly Connection $connection, private readonly CategoryDefinition $definition, private readonly IteratorFactory $iteratorFactory, private readonly RouterInterface $router)
  30.     {
  31.     }
  33.     public function getDecorated(): AbstractUrlProvider
  34.     {
  35.         throw new DecorationPatternException(self::class);
  36.     }
  38.     public function getName(): string
  39.     {
  40.         return 'category';
  41.     }
  43.     /**
  44.      * {@inheritdoc}
  45.      *
  46.      * @throws \Exception
  47.      */
  48.     public function getUrls(SalesChannelContext $context, int $limit, ?int $offset = null): UrlResult
  49.     {
  50.         $categories = $this->getCategories($context, $limit, $offset);
  52.         if (empty($categories)) {
  53.             return new UrlResult([], null);
  54.         }
  55.         $keys = FetchModeHelper::keyPair($categories);
  57.         $seoUrls = $this->getSeoUrls(array_values($keys), 'frontend.navigation.page', $context, $this->connection);
  59.         $seoUrls = FetchModeHelper::groupUnique($seoUrls);
  61.         $urls = [];
  62.         $url = new Url();
  64.         foreach ($categories as $category) {
  65.             if (!isset($seoUrls[$category['id']])) {
  66.                 continue;
  67.             }
  69.             $lastMod = $category['updated_at'] ?: $category['created_at'];
  71.             $lastMod = (new \DateTime($lastMod))->format(Defaults::STORAGE_DATE_TIME_FORMAT);
  73.             $newUrl = clone $url;
  75.             if (isset($seoUrls[$category['id']])) {
  76.                 $newUrl->setLoc($seoUrls[$category['id']]['seo_path_info']);
  77.             } else {
  78.                 $newUrl->setLoc($this->router->generate('frontend.navigation.page', ['navigationId' => $category->getId()], UrlGeneratorInterface::ABSOLUTE_PATH));
  79.             }
  81.             $newUrl->setLastmod(new \DateTime($lastMod));
  82.             $newUrl->setChangefreq(self::CHANGE_FREQ);
  83.             $newUrl->setResource(CategoryEntity::class);
  84.             $newUrl->setIdentifier($category['id']);
  86.             $urls[] = $newUrl;
  87.         }
  89.         $keys = array_keys($keys);
  90.         /** @var int|null $nextOffset */
  91.         $nextOffset = array_pop($keys);
  93.         return new UrlResult($urls, $nextOffset);
  94.     }
  96.     private function getCategories(SalesChannelContext $context, int $limit, ?int $offset): array
  97.     {
  98.         $lastId = null;
  99.         if ($offset) {
  100.             $lastId = ['offset' => $offset];
  101.         }
  103.         $iterator = $this->iteratorFactory->createIterator($this->definition, $lastId);
  104.         $query = $iterator->getQuery();
  105.         $query->setMaxResults($limit);
  107.         $query->addSelect([
  108.             '`category`.created_at',
  109.             '`category`.updated_at',
  110.         ]);
  112.         $wheres = [];
  113.         $categoryIds = array_filter([
  114.             $context->getSalesChannel()->getNavigationCategoryId(),
  115.             $context->getSalesChannel()->getFooterCategoryId(),
  116.             $context->getSalesChannel()->getServiceCategoryId(),
  117.         ]);
  119.         foreach ($categoryIds as $id) {
  120.             $wheres[] = '`category`.path LIKE ' . $query->createNamedParameter('%|' . $id . '|%');
  121.         }
  123.         $query->andWhere('(' . implode(' OR ', $wheres) . ')');
  124.         $query->andWhere('`category`.version_id = :versionId');
  125.         $query->andWhere('`category`.active = 1');
  126.         $query->andWhere('`category`.type != :linkType');
  128.         $excludedCategoryIds = $this->getExcludedCategoryIds($context);
  129.         if (!empty($excludedCategoryIds)) {
  130.             $query->andWhere('`category`.id NOT IN (:categoryIds)');
  131.             $query->setParameter('categoryIds', Uuid::fromHexToBytesList($excludedCategoryIds), Connection::PARAM_STR_ARRAY);
  132.         }
  134.         $query->setParameter('versionId', Uuid::fromHexToBytes(Defaults::LIVE_VERSION));
  135.         $query->setParameter('linkType', CategoryDefinition::TYPE_LINK);
  137.         return $query->executeQuery()->fetchAllAssociative();
  138.     }
  140.     private function getExcludedCategoryIds(SalesChannelContext $salesChannelContext): array
  141.     {
  142.         $salesChannelId = $salesChannelContext->getSalesChannel()->getId();
  144.         $excludedUrls = $this->configHandler->get(ConfigHandler::EXCLUDED_URLS_KEY);
  145.         if (empty($excludedUrls)) {
  146.             return [];
  147.         }
  149.         $excludedUrls = array_filter($excludedUrls, static function (array $excludedUrl) use ($salesChannelId) {
  150.             if ($excludedUrl['resource'] !== CategoryEntity::class) {
  151.                 return false;
  152.             }
  154.             if ($excludedUrl['salesChannelId'] !== $salesChannelId) {
  155.                 return false;
  156.             }
  158.             return true;
  159.         });
  161.         return array_column($excludedUrls, 'identifier');
  162.     }
  163. }