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

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\System\SalesChannel\SalesChannelContext;
  12. use Twig\Extension\AbstractExtension;
  13. use Twig\TwigFunction;
  15. class BuildBreadcrumbExtension extends AbstractExtension
  16. {
  17.     /**
  18.      * @var CategoryBreadcrumbBuilder
  19.      */
  20.     private $categoryBreadcrumbBuilder;
  22.     /**
  23.      * @var EntityRepositoryInterface
  24.      */
  25.     private $categoryRepository;
  27.     /**
  28.      * @internal
  29.      */
  30.     public function __construct(CategoryBreadcrumbBuilder $categoryBreadcrumbBuilder, EntityRepositoryInterface $categoryRepository)
  31.     {
  32.         $this->categoryBreadcrumbBuilder = $categoryBreadcrumbBuilder;
  33.         $this->categoryRepository = $categoryRepository;
  34.     }
  36.     public function getFunctions(): array
  37.     {
  38.         return [
  39.             new TwigFunction('sw_breadcrumb_full', [$this, 'getFullBreadcrumb'], ['needs_context' => true]),
  41.             /*
  42.              * @deprecated tag:v6.5.0 - Will be deleted, use sw_breadcrumb_full instead.
  43.              */
  44.             new TwigFunction('sw_breadcrumb', [$this, 'buildSeoBreadcrumb'], ['needs_context' => true]),
  46.             /*
  47.              * @deprecated tag:v6.5.0 - Will be deleted, use sw_breadcrumb_full instead.
  48.              */
  49.             new TwigFunction('sw_breadcrumb_types', [$this, 'getCategoryTypes']),
  51.             /*
  52.              * @deprecated tag:v6.5.0 - Will be deleted, without a replacement.
  53.              */
  54.             new TwigFunction('sw_breadcrumb_build_types', [$this, 'buildCategoryTypes']),
  55.         ];
  56.     }
  58.     public function getFullBreadcrumb(array $twigContext, CategoryEntity $category, Context $context): array
  59.     {
  60.         $salesChannel = null;
  61.         if (\array_key_exists('context', $twigContext) && $twigContext['context'] instanceof SalesChannelContext) {
  62.             $salesChannel = $twigContext['context']->getSalesChannel();
  63.         }
  65.         $seoBreadcrumb = $this->categoryBreadcrumbBuilder->build($category, $salesChannel);
  67.         if ($seoBreadcrumb === null) {
  68.             return [];
  69.         }
  71.         $categoryIds = array_keys($seoBreadcrumb);
  72.         if (empty($categoryIds)) {
  73.             return [];
  74.         }
  76.         $criteria = new Criteria($categoryIds);
  77.         $criteria->setTitle('breadcrumb-extension');
  78.         $categories = $this->categoryRepository->search($criteria, $context)->getEntities();
  80.         $breadcrumb = [];
  81.         foreach ($categoryIds as $categoryId) {
  82.             if ($categories->get($categoryId) === null) {
  83.                 continue;
  84.             }
  86.             $breadcrumb[$categoryId] = $categories->get($categoryId);
  87.         }
  89.         return $breadcrumb;
  90.     }
  92.     /**
  93.      * @deprecated tag:v6.5.0 - Will be set to private or deleted, without a replacement.
  94.      */
  95.     public function buildSeoBreadcrumb(array $twigContext, CategoryEntity $category, ?string $navigationCategoryId = null): ?array
  96.     {
  97.         Feature::triggerDeprecationOrThrow(
  98.             'v6.5.0.0',
  99.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'sw_breadcrumb_full')
  100.         );
  102.         $salesChannel = null;
  103.         if (\array_key_exists('context', $twigContext) && $twigContext['context'] instanceof SalesChannelContext) {
  104.             $salesChannel = $twigContext['context']->getSalesChannel();
  105.         }
  107.         return $this->categoryBreadcrumbBuilder->build($category, $salesChannel, $navigationCategoryId);
  108.     }
  110.     /**
  111.      * @deprecated tag:v6.5.0 - Will be deleted, use getFullBreadcrumb instead.
  112.      */
  113.     public function getCategoryTypes(array $categoryIds, Context $context): array
  114.     {
  115.         Feature::triggerDeprecationOrThrow(
  116.             'v6.5.0.0',
  117.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'sw_breadcrumb_full')
  118.         );
  120.         return $this->buildCategoryTypes($this->getCategories($categoryIds, $context));
  121.     }
  123.     /**
  124.      * @deprecated tag:v6.5.0 - Will be deleted, use getFullBreadcrumb instead.
  125.      *
  126.      * @param CategoryEntity[] $categories
  127.      */
  128.     public function buildCategoryTypes(array $categories): array
  129.     {
  130.         Feature::triggerDeprecationOrThrow(
  131.             'v6.5.0.0',
  132.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'sw_breadcrumb_full')
  133.         );
  135.         if (\count($categories) === 0) {
  136.             return [];
  137.         }
  139.         $types = [];
  141.         foreach ($categories as $category) {
  142.             $types[$category->getId()] = $category->getType();
  143.         }
  145.         return $types;
  146.     }
  148.     private function getCategories(array $categoryIds, Context $context): array
  149.     {
  150.         if (\count($categoryIds) === 0) {
  151.             return [];
  152.         }
  154.         return $this->categoryRepository->search(new Criteria($categoryIds), $context)->getElements();
  155.     }
  156. }