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

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. /**
  16.  * @package core
  17.  */
  18. class BuildBreadcrumbExtension extends AbstractExtension
  19. {
  20.     /**
  21.      * @var CategoryBreadcrumbBuilder
  22.      */
  23.     private $categoryBreadcrumbBuilder;
  25.     /**
  26.      * @var EntityRepositoryInterface
  27.      */
  28.     private $categoryRepository;
  30.     /**
  31.      * @internal
  32.      */
  33.     public function __construct(CategoryBreadcrumbBuilder $categoryBreadcrumbBuilder, EntityRepositoryInterface $categoryRepository)
  34.     {
  35.         $this->categoryBreadcrumbBuilder = $categoryBreadcrumbBuilder;
  36.         $this->categoryRepository = $categoryRepository;
  37.     }
  39.     public function getFunctions(): array
  40.     {
  41.         return [
  42.             new TwigFunction('sw_breadcrumb_full', [$this, 'getFullBreadcrumb'], ['needs_context' => true]),
  44.             /*
  45.              * @deprecated tag:v6.5.0 - Will be deleted, use sw_breadcrumb_full instead.
  46.              */
  47.             new TwigFunction('sw_breadcrumb', [$this, 'buildSeoBreadcrumb'], ['needs_context' => true]),
  49.             /*
  50.              * @deprecated tag:v6.5.0 - Will be deleted, use sw_breadcrumb_full instead.
  51.              */
  52.             new TwigFunction('sw_breadcrumb_types', [$this, 'getCategoryTypes']),
  54.             /*
  55.              * @deprecated tag:v6.5.0 - Will be deleted, without a replacement.
  56.              */
  57.             new TwigFunction('sw_breadcrumb_build_types', [$this, 'buildCategoryTypes']),
  58.         ];
  59.     }
  61.     public function getFullBreadcrumb(array $twigContext, CategoryEntity $category, Context $context): array
  62.     {
  63.         $salesChannel = null;
  64.         if (\array_key_exists('context', $twigContext) && $twigContext['context'] instanceof SalesChannelContext) {
  65.             $salesChannel = $twigContext['context']->getSalesChannel();
  66.         }
  68.         $seoBreadcrumb = $this->categoryBreadcrumbBuilder->build($category, $salesChannel);
  70.         if ($seoBreadcrumb === null) {
  71.             return [];
  72.         }
  74.         $categoryIds = array_keys($seoBreadcrumb);
  75.         if (empty($categoryIds)) {
  76.             return [];
  77.         }
  79.         $criteria = new Criteria($categoryIds);
  80.         $criteria->setTitle('breadcrumb-extension');
  81.         $categories = $this->categoryRepository->search($criteria, $context)->getEntities();
  83.         $breadcrumb = [];
  84.         foreach ($categoryIds as $categoryId) {
  85.             if ($categories->get($categoryId) === null) {
  86.                 continue;
  87.             }
  89.             $breadcrumb[$categoryId] = $categories->get($categoryId);
  90.         }
  92.         return $breadcrumb;
  93.     }
  95.     /**
  96.      * @deprecated tag:v6.5.0 - Will be set to private or deleted, without a replacement.
  97.      */
  98.     public function buildSeoBreadcrumb(array $twigContext, CategoryEntity $category, ?string $navigationCategoryId = null): ?array
  99.     {
  100.         Feature::triggerDeprecationOrThrow(
  101.             'v6.5.0.0',
  102.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'sw_breadcrumb_full')
  103.         );
  105.         $salesChannel = null;
  106.         if (\array_key_exists('context', $twigContext) && $twigContext['context'] instanceof SalesChannelContext) {
  107.             $salesChannel = $twigContext['context']->getSalesChannel();
  108.         }
  110.         return $this->categoryBreadcrumbBuilder->build($category, $salesChannel, $navigationCategoryId);
  111.     }
  113.     /**
  114.      * @deprecated tag:v6.5.0 - Will be deleted, use getFullBreadcrumb instead.
  115.      *
  116.      * @param array<string> $categoryIds
  117.      */
  118.     public function getCategoryTypes(array $categoryIds, Context $context): array
  119.     {
  120.         Feature::triggerDeprecationOrThrow(
  121.             'v6.5.0.0',
  122.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'sw_breadcrumb_full')
  123.         );
  125.         return $this->buildCategoryTypes($this->getCategories($categoryIds, $context));
  126.     }
  128.     /**
  129.      * @deprecated tag:v6.5.0 - Will be deleted, use getFullBreadcrumb instead.
  130.      *
  131.      * @param CategoryEntity[] $categories
  132.      */
  133.     public function buildCategoryTypes(array $categories): array
  134.     {
  135.         Feature::triggerDeprecationOrThrow(
  136.             'v6.5.0.0',
  137.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'sw_breadcrumb_full')
  138.         );
  140.         if (\count($categories) === 0) {
  141.             return [];
  142.         }
  144.         $types = [];
  146.         foreach ($categories as $category) {
  147.             $types[$category->getId()] = $category->getType();
  148.         }
  150.         return $types;
  151.     }
  153.     /**
  154.      * @param array<string> $categoryIds
  155.      */
  156.     private function getCategories(array $categoryIds, Context $context): array
  157.     {
  158.         if (\count($categoryIds) === 0) {
  159.             return [];
  160.         }
  162.         return $this->categoryRepository->search(new Criteria($categoryIds), $context)->getElements();
  163.     }
  164. }