vendor/shopware/storefront/Page/Product/ProductPageLoader.php line 158

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Page\Product;
  5. use Shopware\Core\Content\Category\Exception\CategoryNotFoundException;
  6. use Shopware\Core\Content\Product\Aggregate\ProductMedia\ProductMediaCollection;
  7. use Shopware\Core\Content\Product\Aggregate\ProductMedia\ProductMediaEntity;
  8. use Shopware\Core\Content\Product\Exception\ProductNotFoundException;
  9. use Shopware\Core\Content\Product\SalesChannel\CrossSelling\AbstractProductCrossSellingRoute;
  10. use Shopware\Core\Content\Product\SalesChannel\Detail\AbstractProductDetailRoute;
  11. use Shopware\Core\Content\Product\SalesChannel\SalesChannelProductEntity;
  12. use Shopware\Core\Content\Property\Aggregate\PropertyGroupOption\PropertyGroupOptionCollection;
  13. use Shopware\Core\Content\Property\PropertyGroupCollection;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Exception\InconsistentCriteriaIdsException;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  16. use Shopware\Core\Framework\Feature;
  17. use Shopware\Core\Framework\Log\Package;
  18. use Shopware\Core\Framework\Routing\Exception\MissingRequestParameterException;
  19. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  20. use Shopware\Storefront\Page\GenericPageLoaderInterface;
  21. use Shopware\Storefront\Page\Product\Review\ProductReviewLoader;
  22. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  23. use Symfony\Component\HttpFoundation\Request;
  25. #[Package('storefront')]
  26. class ProductPageLoader
  27. {
  28.     /**
  29.      * @internal
  30.      */
  31.     public function __construct(private readonly GenericPageLoaderInterface $genericLoader, private readonly EventDispatcherInterface $eventDispatcher, private readonly AbstractProductDetailRoute $productDetailRoute, private readonly ProductReviewLoader $productReviewLoader, private readonly AbstractProductCrossSellingRoute $crossSellingRoute)
  32.     {
  33.     }
  35.     /**
  36.      * @throws CategoryNotFoundException
  37.      * @throws InconsistentCriteriaIdsException
  38.      * @throws MissingRequestParameterException
  39.      * @throws ProductNotFoundException
  40.      */
  41.     public function load(Request $request, SalesChannelContext $context): ProductPage
  42.     {
  43.         $productId = $request->attributes->get('productId');
  44.         if (!$productId) {
  45.             throw new MissingRequestParameterException('productId', '/productId');
  46.         }
  48.         $criteria = (new Criteria())
  49.             ->addAssociation('manufacturer.media')
  50.             ->addAssociation('options.group')
  51.             ->addAssociation('properties.group')
  52.             ->addAssociation('mainCategories.category')
  53.             ->addAssociation('media');
  55.         $this->eventDispatcher->dispatch(new ProductPageCriteriaEvent($productId, $criteria, $context));
  57.         $result = $this->productDetailRoute->load($productId, $request, $context, $criteria);
  58.         $product = $result->getProduct();
  60.         if ($product->getMedia()) {
  61.             $product->getMedia()->sort(fn (ProductMediaEntity $a, ProductMediaEntity $b) => $a->getPosition() <=> $b->getPosition());
  62.         }
  64.         if ($product->getMedia() && $product->getCover()) {
  65.             $product->setMedia(new ProductMediaCollection(array_merge(
  66.                 [$product->getCover()->getId() => $product->getCover()],
  67.                 $product->getMedia()->getElements()
  68.             )));
  69.         }
  71.         if ($category = $product->getSeoCategory()) {
  72.             $request->request->set('navigationId', $category->getId());
  73.         }
  75.         $page = $this->genericLoader->load($request, $context);
  76.         $page = ProductPage::createFrom($page);
  78.         $page->setProduct($product);
  79.         $page->setConfiguratorSettings($result->getConfigurator() ?? new PropertyGroupCollection());
  80.         $page->setNavigationId($product->getId());
  82.         if (!Feature::isActive('v6.6.0.0')) {
  83.             $this->loadDefaultAdditions($product, $page, $request, $context);
  84.         } elseif ($cmsPage = $product->getCmsPage()) {
  85.             $page->setCmsPage($cmsPage);
  86.         }
  88.         $this->loadOptions($page);
  89.         $this->loadMetaData($page);
  91.         $this->eventDispatcher->dispatch(
  92.             new ProductPageLoadedEvent($page, $context, $request)
  93.         );
  95.         return $page;
  96.     }
  98.     private function loadOptions(ProductPage $page): void
  99.     {
  100.         $options = new PropertyGroupOptionCollection();
  102.         if (($optionIds = $page->getProduct()->getOptionIds()) === null) {
  103.             $page->setSelectedOptions($options);
  105.             return;
  106.         }
  108.         foreach ($page->getConfiguratorSettings() as $group) {
  109.             $groupOptions = $group->getOptions();
  110.             if ($groupOptions === null) {
  111.                 continue;
  112.             }
  113.             foreach ($optionIds as $optionId) {
  114.                 $groupOption = $groupOptions->get($optionId);
  115.                 if ($groupOption !== null) {
  116.                     $options->add($groupOption);
  117.                 }
  118.             }
  119.         }
  121.         $page->setSelectedOptions($options);
  122.     }
  124.     private function loadMetaData(ProductPage $page): void
  125.     {
  126.         $metaInformation = $page->getMetaInformation();
  128.         if (!$metaInformation) {
  129.             return;
  130.         }
  132.         $metaDescription = $page->getProduct()->getTranslation('metaDescription')
  133.             ?? $page->getProduct()->getTranslation('description');
  134.         $metaInformation->setMetaDescription((string) $metaDescription);
  136.         $metaInformation->setMetaKeywords((string) $page->getProduct()->getTranslation('keywords'));
  138.         if ((string) $page->getProduct()->getTranslation('metaTitle') !== '') {
  139.             $metaInformation->setMetaTitle((string) $page->getProduct()->getTranslation('metaTitle'));
  141.             return;
  142.         }
  144.         $metaTitleParts = [$page->getProduct()->getTranslation('name')];
  146.         foreach ($page->getSelectedOptions() as $option) {
  147.             $metaTitleParts[] = $option->getTranslation('name');
  148.         }
  150.         $metaTitleParts[] = $page->getProduct()->getProductNumber();
  152.         $metaInformation->setMetaTitle(implode(' | ', $metaTitleParts));
  153.     }
  155.     /**
  156.      * @@deprecated tag:v6.6.0 - will be removed because cms page id will always be set
  157.      */
  158.     private function loadDefaultAdditions(SalesChannelProductEntity $product, ProductPage $page, Request $request, SalesChannelContext $context): void
  159.     {
  160.         if ($cmsPage = $product->getCmsPage()) {
  161.             $page->setCmsPage($cmsPage);
  163.             return;
  164.         }
  166.         $request->request->set('parentId', $product->getParentId());
  167.         $reviews = $this->productReviewLoader->load($request, $context);
  168.         $reviews->setParentId($product->getParentId() ?? $product->getId());
  170.         $page->setReviews($reviews);
  172.         $crossSellings = $this->crossSellingRoute->load($product->getId(), new Request(), $context, new Criteria());
  174.         $page->setCrossSellings($crossSellings->getResult());
  175.     }
  176. }