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

  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. /**
  26.  * Do not use direct or indirect repository calls in a PageLoader. Always use a store-api route to get or put data.
  27.  */
  28. #[Package('storefront')]
  29. class ProductPageLoader
  30. {
  31.     /**
  32.      * @internal
  33.      */
  34.     public function __construct(
  35.         private readonly GenericPageLoaderInterface $genericLoader,
  36.         private readonly EventDispatcherInterface $eventDispatcher,
  37.         private readonly AbstractProductDetailRoute $productDetailRoute,
  38.         private readonly ProductReviewLoader $productReviewLoader,
  39.         private readonly AbstractProductCrossSellingRoute $crossSellingRoute
  40.     ) {
  41.     }
  43.     /**
  44.      * @throws CategoryNotFoundException
  45.      * @throws InconsistentCriteriaIdsException
  46.      * @throws MissingRequestParameterException
  47.      * @throws ProductNotFoundException
  48.      */
  49.     public function load(Request $request, SalesChannelContext $context): ProductPage
  50.     {
  51.         $productId = $request->attributes->get('productId');
  52.         if (!$productId) {
  53.             throw new MissingRequestParameterException('productId', '/productId');
  54.         }
  56.         $criteria = (new Criteria())
  57.             ->addAssociation('manufacturer.media')
  58.             ->addAssociation('options.group')
  59.             ->addAssociation('properties.group')
  60.             ->addAssociation('mainCategories.category')
  61.             ->addAssociation('media');
  63.         $this->eventDispatcher->dispatch(new ProductPageCriteriaEvent($productId, $criteria, $context));
  65.         $result = $this->productDetailRoute->load($productId, $request, $context, $criteria);
  66.         $product = $result->getProduct();
  68.         if ($product->getMedia()) {
  69.             $product->getMedia()->sort(fn (ProductMediaEntity $a, ProductMediaEntity $b) => $a->getPosition() <=> $b->getPosition());
  70.         }
  72.         if ($product->getMedia() && $product->getCover()) {
  73.             $product->setMedia(new ProductMediaCollection(array_merge(
  74.                 [$product->getCover()->getId() => $product->getCover()],
  75.                 $product->getMedia()->getElements()
  76.             )));
  77.         }
  79.         if ($category = $product->getSeoCategory()) {
  80.             $request->request->set('navigationId', $category->getId());
  81.         }
  83.         $page = $this->genericLoader->load($request, $context);
  84.         $page = ProductPage::createFrom($page);
  86.         $page->setProduct($product);
  87.         $page->setConfiguratorSettings($result->getConfigurator() ?? new PropertyGroupCollection());
  88.         $page->setNavigationId($product->getId());
  90.         if (!Feature::isActive('v6.6.0.0')) {
  91.             $this->loadDefaultAdditions($product, $page, $request, $context);
  92.         } elseif ($cmsPage = $product->getCmsPage()) {
  93.             $page->setCmsPage($cmsPage);
  94.         }
  96.         $this->loadOptions($page);
  97.         $this->loadMetaData($page);
  99.         $this->eventDispatcher->dispatch(
  100.             new ProductPageLoadedEvent($page, $context, $request)
  101.         );
  103.         return $page;
  104.     }
  106.     private function loadOptions(ProductPage $page): void
  107.     {
  108.         $options = new PropertyGroupOptionCollection();
  110.         if (($optionIds = $page->getProduct()->getOptionIds()) === null) {
  111.             $page->setSelectedOptions($options);
  113.             return;
  114.         }
  116.         foreach ($page->getConfiguratorSettings() as $group) {
  117.             $groupOptions = $group->getOptions();
  118.             if ($groupOptions === null) {
  119.                 continue;
  120.             }
  121.             foreach ($optionIds as $optionId) {
  122.                 $groupOption = $groupOptions->get($optionId);
  123.                 if ($groupOption !== null) {
  124.                     $options->add($groupOption);
  125.                 }
  126.             }
  127.         }
  129.         $page->setSelectedOptions($options);
  130.     }
  132.     private function loadMetaData(ProductPage $page): void
  133.     {
  134.         $metaInformation = $page->getMetaInformation();
  136.         if (!$metaInformation) {
  137.             return;
  138.         }
  140.         $metaDescription = $page->getProduct()->getTranslation('metaDescription')
  141.             ?? $page->getProduct()->getTranslation('description');
  142.         $metaInformation->setMetaDescription((string) $metaDescription);
  144.         $metaInformation->setMetaKeywords((string) $page->getProduct()->getTranslation('keywords'));
  146.         if ((string) $page->getProduct()->getTranslation('metaTitle') !== '') {
  147.             $metaInformation->setMetaTitle((string) $page->getProduct()->getTranslation('metaTitle'));
  149.             return;
  150.         }
  152.         $metaTitleParts = [$page->getProduct()->getTranslation('name')];
  154.         foreach ($page->getSelectedOptions() as $option) {
  155.             $metaTitleParts[] = $option->getTranslation('name');
  156.         }
  158.         $metaTitleParts[] = $page->getProduct()->getProductNumber();
  160.         $metaInformation->setMetaTitle(implode(' | ', $metaTitleParts));
  161.     }
  163.     /**
  164.      * @@deprecated tag:v6.6.0 - will be removed because cms page id will always be set
  165.      */
  166.     private function loadDefaultAdditions(SalesChannelProductEntity $product, ProductPage $page, Request $request, SalesChannelContext $context): void
  167.     {
  168.         if ($cmsPage = $product->getCmsPage()) {
  169.             $page->setCmsPage($cmsPage);
  171.             return;
  172.         }
  174.         $request->request->set('parentId', $product->getParentId());
  175.         $reviews = $this->productReviewLoader->load($request, $context);
  176.         $reviews->setParentId($product->getParentId() ?? $product->getId());
  178.         $page->setReviews($reviews);
  180.         $crossSellings = $this->crossSellingRoute->load($product->getId(), new Request(), $context, new Criteria());
  182.         $page->setCrossSellings($crossSellings->getResult());
  183.     }
  184. }