vendor/shopware/core/Framework/Adapter/Twig/Extension/BuildBreadcrumbExtension.php line 97

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\Adapter\Twig\Extension;
  5. use Shopware\Core\Content\Category\CategoryEntity;
  6. use Shopware\Core\Content\Category\Service\CategoryBreadcrumbBuilder;
  7. use Shopware\Core\Framework\Context;
  8. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepositoryInterface;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  10. use Shopware\Core\Framework\Feature;
  11. use Shopware\Core\Framework\Log\Package;
  12. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  13. use Twig\Extension\AbstractExtension;
  14. use Twig\TwigFunction;
  16. #[Package('core')]
  17. class BuildBreadcrumbExtension extends AbstractExtension
  18. {
  19.     /**
  20.      * @var CategoryBreadcrumbBuilder
  21.      */
  22.     private $categoryBreadcrumbBuilder;
  24.     /**
  25.      * @var EntityRepositoryInterface
  26.      */
  27.     private $categoryRepository;
  29.     /**
  30.      * @internal
  31.      */
  32.     public function __construct(CategoryBreadcrumbBuilder $categoryBreadcrumbBuilder, EntityRepositoryInterface $categoryRepository)
  33.     {
  34.         $this->categoryBreadcrumbBuilder = $categoryBreadcrumbBuilder;
  35.         $this->categoryRepository = $categoryRepository;
  36.     }
  38.     public function getFunctions(): array
  39.     {
  40.         return [
  41.             new TwigFunction('sw_breadcrumb_full', [$this, 'getFullBreadcrumb'], ['needs_context' => true]),
  43.             /*
  44.              * @deprecated tag:v6.5.0 - Will be deleted, use sw_breadcrumb_full instead.
  45.              */
  46.             new TwigFunction('sw_breadcrumb', [$this, 'buildSeoBreadcrumb'], ['needs_context' => true]),
  48.             /*
  49.              * @deprecated tag:v6.5.0 - Will be deleted, use sw_breadcrumb_full instead.
  50.              */
  51.             new TwigFunction('sw_breadcrumb_types', [$this, 'getCategoryTypes']),
  53.             /*
  54.              * @deprecated tag:v6.5.0 - Will be deleted, without a replacement.
  55.              */
  56.             new TwigFunction('sw_breadcrumb_build_types', [$this, 'buildCategoryTypes']),
  57.         ];
  58.     }
  60.     public function getFullBreadcrumb(array $twigContext, CategoryEntity $category, Context $context): array
  61.     {
  62.         $salesChannel = null;
  63.         if (\array_key_exists('context', $twigContext) && $twigContext['context'] instanceof SalesChannelContext) {
  64.             $salesChannel = $twigContext['context']->getSalesChannel();
  65.         }
  67.         $seoBreadcrumb = $this->categoryBreadcrumbBuilder->build($category, $salesChannel);
  69.         if ($seoBreadcrumb === null) {
  70.             return [];
  71.         }
  73.         $categoryIds = array_keys($seoBreadcrumb);
  74.         if (empty($categoryIds)) {
  75.             return [];
  76.         }
  78.         $criteria = new Criteria($categoryIds);
  79.         $criteria->setTitle('breadcrumb-extension');
  80.         $categories = $this->categoryRepository->search($criteria, $context)->getEntities();
  82.         $breadcrumb = [];
  83.         foreach ($categoryIds as $categoryId) {
  84.             if ($categories->get($categoryId) === null) {
  85.                 continue;
  86.             }
  88.             $breadcrumb[$categoryId] = $categories->get($categoryId);
  89.         }
  91.         return $breadcrumb;
  92.     }
  94.     /**
  95.      * @deprecated tag:v6.5.0 - Will be set to private or deleted, without a replacement.
  96.      */
  97.     public function buildSeoBreadcrumb(array $twigContext, CategoryEntity $category, ?string $navigationCategoryId = null): ?array
  98.     {
  99.         Feature::triggerDeprecationOrThrow(
  100.             'v6.5.0.0',
  101.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'sw_breadcrumb_full')
  102.         );
  104.         $salesChannel = null;
  105.         if (\array_key_exists('context', $twigContext) && $twigContext['context'] instanceof SalesChannelContext) {
  106.             $salesChannel = $twigContext['context']->getSalesChannel();
  107.         }
  109.         return $this->categoryBreadcrumbBuilder->build($category, $salesChannel, $navigationCategoryId);
  110.     }
  112.     /**
  113.      * @deprecated tag:v6.5.0 - Will be deleted, use getFullBreadcrumb instead.
  114.      *
  115.      * @param array<string> $categoryIds
  116.      */
  117.     public function getCategoryTypes(array $categoryIds, Context $context): array
  118.     {
  119.         Feature::triggerDeprecationOrThrow(
  120.             'v6.5.0.0',
  121.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'sw_breadcrumb_full')
  122.         );
  124.         return $this->buildCategoryTypes($this->getCategories($categoryIds, $context));
  125.     }
  127.     /**
  128.      * @deprecated tag:v6.5.0 - Will be deleted, use getFullBreadcrumb instead.
  129.      *
  130.      * @param CategoryEntity[] $categories
  131.      */
  132.     public function buildCategoryTypes(array $categories): array
  133.     {
  134.         Feature::triggerDeprecationOrThrow(
  135.             'v6.5.0.0',
  136.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'sw_breadcrumb_full')
  137.         );
  139.         if (\count($categories) === 0) {
  140.             return [];
  141.         }
  143.         $types = [];
  145.         foreach ($categories as $category) {
  146.             $types[$category->getId()] = $category->getType();
  147.         }
  149.         return $types;
  150.     }
  152.     /**
  153.      * @param array<string> $categoryIds
  154.      */
  155.     private function getCategories(array $categoryIds, Context $context): array
  156.     {
  157.         if (\count($categoryIds) === 0) {
  158.             return [];
  159.         }
  161.         return $this->categoryRepository->search(new Criteria($categoryIds), $context)->getElements();
  162.     }
  163. }