vendor/shopware/storefront/Controller/ProductController.php line 88

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Controller;
  5. use Shopware\Core\Content\Product\Exception\ProductNotFoundException;
  6. use Shopware\Core\Content\Product\Exception\ReviewNotActiveExeption;
  7. use Shopware\Core\Content\Product\Exception\VariantNotFoundException;
  8. use Shopware\Core\Content\Product\SalesChannel\FindVariant\AbstractFindProductVariantRoute;
  9. use Shopware\Core\Content\Product\SalesChannel\Review\AbstractProductReviewSaveRoute;
  10. use Shopware\Core\Content\Seo\SeoUrlPlaceholderHandlerInterface;
  11. use Shopware\Core\Framework\Feature;
  12. use Shopware\Core\Framework\Log\Package;
  13. use Shopware\Core\Framework\Routing\Annotation\Since;
  14. use Shopware\Core\Framework\Validation\DataBag\RequestDataBag;
  15. use Shopware\Core\Framework\Validation\Exception\ConstraintViolationException;
  16. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  17. use Shopware\Core\System\SystemConfig\SystemConfigService;
  18. use Shopware\Storefront\Framework\Cache\Annotation\HttpCache;
  19. use Shopware\Storefront\Framework\Routing\RequestTransformer;
  20. use Shopware\Storefront\Page\Product\Configurator\ProductCombinationFinder;
  21. use Shopware\Storefront\Page\Product\ProductPageLoadedHook;
  22. use Shopware\Storefront\Page\Product\ProductPageLoader;
  23. use Shopware\Storefront\Page\Product\QuickView\MinimalQuickViewPageLoader;
  24. use Shopware\Storefront\Page\Product\QuickView\ProductQuickViewWidgetLoadedHook;
  25. use Shopware\Storefront\Page\Product\Review\ProductReviewLoader;
  26. use Shopware\Storefront\Page\Product\Review\ProductReviewsWidgetLoadedHook;
  27. use Symfony\Component\HttpFoundation\JsonResponse;
  28. use Symfony\Component\HttpFoundation\Request;
  29. use Symfony\Component\HttpFoundation\Response;
  30. use Symfony\Component\HttpKernel\EventListener\AbstractSessionListener;
  31. use Symfony\Component\Routing\Annotation\Route;
  33. /**
  34.  * @Route(defaults={"_routeScope"={"storefront"}})
  35.  *
  36.  * @deprecated tag:v6.5.0 - reason:becomes-internal - Will be internal
  37.  */
  38. #[Package('storefront')]
  39. class ProductController extends StorefrontController
  40. {
  41.     private ProductPageLoader $productPageLoader;
  43.     private AbstractFindProductVariantRoute $findVariantRoute;
  45.     private MinimalQuickViewPageLoader $minimalQuickViewPageLoader;
  47.     private SeoUrlPlaceholderHandlerInterface $seoUrlPlaceholderHandler;
  49.     private ProductReviewLoader $productReviewLoader;
  51.     private SystemConfigService $systemConfigService;
  53.     private AbstractProductReviewSaveRoute $productReviewSaveRoute;
  55.     /**
  56.      * @deprecated tag:v6.5.0 - will be removed
  57.      */
  58.     private ProductCombinationFinder $productCombinationFinder;
  60.     /**
  61.      * @internal
  62.      */
  63.     public function __construct(
  64.         ProductPageLoader $productPageLoader,
  65.         ProductCombinationFinder $productCombinationFinder,
  66.         AbstractFindProductVariantRoute $findVariantRoute,
  67.         MinimalQuickViewPageLoader $minimalQuickViewPageLoader,
  68.         AbstractProductReviewSaveRoute $productReviewSaveRoute,
  69.         SeoUrlPlaceholderHandlerInterface $seoUrlPlaceholderHandler,
  70.         ProductReviewLoader $productReviewLoader,
  71.         SystemConfigService $systemConfigService
  72.     ) {
  73.         $this->productPageLoader = $productPageLoader;
  74.         $this->findVariantRoute = $findVariantRoute;
  75.         $this->minimalQuickViewPageLoader = $minimalQuickViewPageLoader;
  76.         $this->seoUrlPlaceholderHandler = $seoUrlPlaceholderHandler;
  77.         $this->productReviewLoader = $productReviewLoader;
  78.         $this->systemConfigService = $systemConfigService;
  79.         $this->productReviewSaveRoute = $productReviewSaveRoute;
  80.         $this->productCombinationFinder = $productCombinationFinder;
  81.     }
  83.     /**
  84.      * @Since("6.3.3.0")
  85.      * @HttpCache()
  86.      * @Route("/detail/{productId}", name="frontend.detail.page", methods={"GET"})
  87.      */
  88.     public function index(SalesChannelContext $context, Request $request): Response
  89.     {
  90.         $page = $this->productPageLoader->load($request, $context);
  92.         $this->hook(new ProductPageLoadedHook($page, $context));
  94.         $ratingSuccess = $request->get('success');
  96.         /**
  97.          * @deprecated tag:v6.5.0 - remove complete if statement, cms page id is always set
  98.          *
  99.          * Fallback layout for non-assigned product layout
  100.          */
  101.         if (!$page->getCmsPage()) {
  102.             Feature::throwException('v6.5.0.0', 'Fallback will be removed because cms page is always set in subscriber.');
  104.             return $this->renderStorefront('@Storefront/storefront/page/product-detail/index.html.twig', ['page' => $page, 'ratingSuccess' => $ratingSuccess]);
  105.         }
  107.         return $this->renderStorefront('@Storefront/storefront/page/content/product-detail.html.twig', ['page' => $page]);
  108.     }
  110.     /**
  111.      * @Since("6.0.0.0")
  112.      * @HttpCache()
  113.      * @Route("/detail/{productId}/switch", name="frontend.detail.switch", methods={"GET"}, defaults={"XmlHttpRequest": true})
  114.      */
  115.     public function switch(string $productId, Request $request, SalesChannelContext $salesChannelContext): JsonResponse
  116.     {
  117.         $switchedGroup = $request->query->has('switched') ? (string) $request->query->get('switched') : null;
  119.         /** @var array<mixed>|null $options */
  120.         $options = json_decode($request->query->get('options', ''), true);
  122.         try {
  123.             if (Feature::isActive('v6.5.0.0')) {
  124.                 $variantResponse = $this->findVariantRoute->load(
  125.                     $productId,
  126.                     new Request(
  127.                         [
  128.                             'switchedGroup' => $switchedGroup,
  129.                             'options' => $options ?? [],
  130.                         ]
  131.                     ),
  132.                     $salesChannelContext
  133.                 );
  135.                 $productId = $variantResponse->getFoundCombination()->getVariantId();
  136.             } else {
  137.                 $finderResponse = $this->productCombinationFinder->find(
  138.                     $productId,
  139.                     $switchedGroup,
  140.                     $options ?? [],
  141.                     $salesChannelContext
  142.                 );
  144.                 $productId = $finderResponse->getVariantId();
  145.             }
  146.         } catch (VariantNotFoundException|ProductNotFoundException $productNotFoundException) {
  147.             //nth
  148.         }
  150.         $host = $request->attributes->get(RequestTransformer::SALES_CHANNEL_ABSOLUTE_BASE_URL)
  151.             . $request->attributes->get(RequestTransformer::SALES_CHANNEL_BASE_URL);
  153.         $url = $this->seoUrlPlaceholderHandler->replace(
  154.             $this->seoUrlPlaceholderHandler->generate(
  155.                 'frontend.detail.page',
  156.                 ['productId' => $productId]
  157.             ),
  158.             $host,
  159.             $salesChannelContext
  160.         );
  162.         $response = new JsonResponse([
  163.             'url' => $url,
  164.             'productId' => $productId,
  165.         ]);
  166.         $response->headers->set(AbstractSessionListener::NO_AUTO_CACHE_CONTROL_HEADER, '1');
  168.         return $response;
  169.     }
  171.     /**
  172.      * @Since("6.0.0.0")
  173.      * @Route("/quickview/{productId}", name="widgets.quickview.minimal", methods={"GET"}, defaults={"XmlHttpRequest": true})
  174.      */
  175.     public function quickviewMinimal(Request $request, SalesChannelContext $context): Response
  176.     {
  177.         $page = $this->minimalQuickViewPageLoader->load($request, $context);
  179.         $this->hook(new ProductQuickViewWidgetLoadedHook($page, $context));
  181.         return $this->renderStorefront('@Storefront/storefront/component/product/quickview/minimal.html.twig', ['page' => $page]);
  182.     }
  184.     /**
  185.      * @Since("6.0.0.0")
  186.      * @Route("/product/{productId}/rating", name="frontend.detail.review.save", methods={"POST"}, defaults={"XmlHttpRequest"=true, "_loginRequired"=true})
  187.      */
  188.     public function saveReview(string $productId, RequestDataBag $data, SalesChannelContext $context): Response
  189.     {
  190.         $this->checkReviewsActive($context);
  192.         try {
  193.             $this->productReviewSaveRoute->save($productId, $data, $context);
  194.         } catch (ConstraintViolationException $formViolations) {
  195.             return $this->forwardToRoute('frontend.product.reviews', [
  196.                 'productId' => $productId,
  197.                 'success' => -1,
  198.                 'formViolations' => $formViolations,
  199.                 'data' => $data,
  200.             ], ['productId' => $productId]);
  201.         }
  203.         $forwardParams = [
  204.             'productId' => $productId,
  205.             'success' => 1,
  206.             'data' => $data,
  207.             'parentId' => $data->get('parentId'),
  208.         ];
  210.         if ($data->has('id')) {
  211.             $forwardParams['success'] = 2;
  212.         }
  214.         return $this->forwardToRoute('frontend.product.reviews', $forwardParams, ['productId' => $productId]);
  215.     }
  217.     /**
  218.      * @Since("6.0.0.0")
  219.      * @Route("/product/{productId}/reviews", name="frontend.product.reviews", methods={"GET","POST"}, defaults={"XmlHttpRequest"=true})
  220.      */
  221.     public function loadReviews(Request $request, RequestDataBag $data, SalesChannelContext $context): Response
  222.     {
  223.         $this->checkReviewsActive($context);
  225.         $reviews = $this->productReviewLoader->load($request, $context);
  227.         $this->hook(new ProductReviewsWidgetLoadedHook($reviews, $context));
  229.         return $this->renderStorefront('storefront/page/product-detail/review/review.html.twig', [
  230.             'reviews' => $reviews,
  231.             'ratingSuccess' => $request->get('success'),
  232.         ]);
  233.     }
  235.     /**
  236.      * @throws ReviewNotActiveExeption
  237.      */
  238.     private function checkReviewsActive(SalesChannelContext $context): void
  239.     {
  240.         $showReview = $this->systemConfigService->get('core.listing.showReview', $context->getSalesChannel()->getId());
  242.         if (!$showReview) {
  243.             throw new ReviewNotActiveExeption();
  244.         }
  245.     }
  246. }