src/Core/Content/Category/Service/CategoryBreadcrumbBuilder.php line 73

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Category\Service;
  5. use Shopware\Core\Content\Category\CategoryDefinition;
  6. use Shopware\Core\Content\Category\CategoryEntity;
  7. use Shopware\Core\Content\Product\ProductEntity;
  8. use Shopware\Core\Content\Seo\MainCategory\MainCategoryEntity;
  9. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\AndFilter;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\ContainsFilter;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsAnyFilter;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\MultiFilter;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\OrFilter;
  17. use Shopware\Core\Framework\Log\Package;
  18. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  19. use Shopware\Core\System\SalesChannel\SalesChannelEntity;
  21. #[Package('content')]
  22. class CategoryBreadcrumbBuilder
  23. {
  24.     /**
  25.      * @internal
  26.      */
  27.     public function __construct(private readonly EntityRepository $categoryRepository)
  28.     {
  29.     }
  31.     /**
  32.      * @return array<mixed>|null
  33.      */
  34.     public function build(CategoryEntity $category, ?SalesChannelEntity $salesChannel = null, ?string $navigationCategoryId = null): ?array
  35.     {
  36.         $categoryBreadcrumb = $category->getPlainBreadcrumb();
  38.         // If the current SalesChannel is null ( which refers to the default template SalesChannel) or
  39.         // this category has no root, we return the full breadcrumb
  40.         if ($salesChannel === null && $navigationCategoryId === null) {
  41.             return $categoryBreadcrumb;
  42.         }
  44.         $entryPoints = [
  45.             $navigationCategoryId,
  46.         ];
  48.         if ($salesChannel !== null) {
  49.             $entryPoints[] = $salesChannel->getNavigationCategoryId();
  50.             $entryPoints[] = $salesChannel->getServiceCategoryId();
  51.             $entryPoints[] = $salesChannel->getFooterCategoryId();
  52.         }
  54.         $entryPoints = array_filter($entryPoints);
  56.         $keys = array_keys($categoryBreadcrumb);
  58.         foreach ($entryPoints as $entryPoint) {
  59.             // Check where this category is located in relation to the navigation entry point of the sales channel
  60.             $pos = array_search($entryPoint, $keys, true);
  62.             if ($pos !== false) {
  63.                 // Remove all breadcrumbs preceding the navigation category
  64.                 return \array_slice($categoryBreadcrumb, $pos + 1);
  65.             }
  66.         }
  68.         return $categoryBreadcrumb;
  69.     }
  71.     public function getProductSeoCategory(ProductEntity $product, SalesChannelContext $context): ?CategoryEntity
  72.     {
  73.         $category = $this->getMainCategory($product, $context);
  75.         if ($category !== null) {
  76.             return $category;
  77.         }
  79.         $categoryIds = $product->getCategoryIds() ?? [];
  80.         $productStreamIds = $product->getStreamIds() ?? [];
  82.         if (empty($productStreamIds) && empty($categoryIds)) {
  83.             return null;
  84.         }
  86.         $criteria = new Criteria();
  87.         $criteria->setTitle('breadcrumb-builder');
  88.         $criteria->setLimit(1);
  89.         $criteria->addFilter(new EqualsFilter('active', true));
  91.         if (!empty($categoryIds)) {
  92.             $criteria->setIds($categoryIds);
  93.         } else {
  94.             $criteria->addFilter(new EqualsAnyFilter('productStream.id', $productStreamIds));
  95.             $criteria->addFilter(new EqualsFilter('productAssignmentType', CategoryDefinition::PRODUCT_ASSIGNMENT_TYPE_PRODUCT_STREAM));
  96.         }
  98.         $criteria->addFilter($this->getSalesChannelFilter($context));
  100.         $categories = $this->categoryRepository->search($criteria, $context->getContext());
  102.         if ($categories->count() > 0) {
  103.             return $categories->first();
  104.         }
  106.         return null;
  107.     }
  109.     private function getSalesChannelFilter(SalesChannelContext $context): MultiFilter
  110.     {
  111.         $ids = array_filter([
  112.             $context->getSalesChannel()->getNavigationCategoryId(),
  113.             $context->getSalesChannel()->getServiceCategoryId(),
  114.             $context->getSalesChannel()->getFooterCategoryId(),
  115.         ]);
  117.         return new OrFilter(array_map(static fn (string $id) => new ContainsFilter('path', '|' . $id . '|'), $ids));
  118.     }
  120.     private function getMainCategory(ProductEntity $product, SalesChannelContext $context): ?CategoryEntity
  121.     {
  122.         $criteria = new Criteria();
  123.         $criteria->setLimit(1);
  124.         $criteria->setTitle('breadcrumb-builder::main-category');
  126.         if (($product->getMainCategories() === null || $product->getMainCategories()->count() <= 0) && $product->getParentId() !== null) {
  127.             $criteria->addFilter($this->getMainCategoryFilter($product->getParentId(), $context));
  128.         } else {
  129.             $criteria->addFilter($this->getMainCategoryFilter($product->getId(), $context));
  130.         }
  132.         $categories = $this->categoryRepository->search($criteria, $context->getContext())->getEntities();
  133.         if ($categories->count() <= 0) {
  134.             return null;
  135.         }
  137.         $firstCategory = $categories->first();
  139.         $entity = $firstCategory instanceof MainCategoryEntity ? $firstCategory->getCategory() : $firstCategory;
  141.         return $product->getCategoryIds() !== null && \in_array($entity->getId(), $product->getCategoryIds(), true) ? $entity : null;
  142.     }
  144.     private function getMainCategoryFilter(string $productId, SalesChannelContext $context): AndFilter
  145.     {
  146.         return new AndFilter([
  147.             new EqualsFilter('mainCategories.productId', $productId),
  148.             new EqualsFilter('mainCategories.salesChannelId', $context->getSalesChannelId()),
  149.             $this->getSalesChannelFilter($context),
  150.         ]);
  151.     }
  152. }