vendor/shopware/storefront/Controller/CmsController.php line 94

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Controller;
  5. use Shopware\Core\Content\Category\SalesChannel\AbstractCategoryRoute;
  6. use Shopware\Core\Content\Cms\Exception\PageNotFoundException;
  7. use Shopware\Core\Content\Cms\SalesChannel\AbstractCmsRoute;
  8. use Shopware\Core\Content\Product\SalesChannel\Detail\AbstractProductDetailRoute;
  9. use Shopware\Core\Content\Product\SalesChannel\Listing\AbstractProductListingRoute;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  11. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  12. use Shopware\Core\Framework\Routing\Annotation\Since;
  13. use Shopware\Core\Framework\Routing\Exception\MissingRequestParameterException;
  14. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  15. use Shopware\Storefront\Event\SwitchBuyBoxVariantEvent;
  16. use Shopware\Storefront\Framework\Cache\Annotation\HttpCache;
  17. use Shopware\Storefront\Page\Cms\CmsPageLoadedHook;
  18. use Shopware\Storefront\Page\Product\Configurator\ProductCombinationFinder;
  19. use Shopware\Storefront\Page\Product\Review\ProductReviewLoader;
  20. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  21. use Symfony\Component\HttpFoundation\JsonResponse;
  22. use Symfony\Component\HttpFoundation\Request;
  23. use Symfony\Component\HttpFoundation\Response;
  24. use Symfony\Component\HttpKernel\EventListener\AbstractSessionListener;
  25. use Symfony\Component\Routing\Annotation\Route;
  27. /**
  28.  * @Route(defaults={"_routeScope"={"storefront"}})
  29.  *
  30.  * @deprecated tag:v6.5.0 - reason:becomes-internal - Will be internal
  31.  */
  32. class CmsController extends StorefrontController
  33. {
  34.     /**
  35.      * @var AbstractCmsRoute
  36.      */
  37.     private $cmsRoute;
  39.     /**
  40.      * @var AbstractCategoryRoute
  41.      */
  42.     private $categoryRoute;
  44.     /**
  45.      * @var AbstractProductListingRoute
  46.      */
  47.     private $listingRoute;
  49.     /**
  50.      * @var AbstractProductDetailRoute
  51.      */
  52.     private $productRoute;
  54.     /**
  55.      * @var ProductReviewLoader
  56.      */
  57.     private $productReviewLoader;
  59.     /**
  60.      * @var ProductCombinationFinder
  61.      */
  62.     private $combinationFinder;
  64.     private EventDispatcherInterface $eventDispatcher;
  66.     /**
  67.      * @internal
  68.      */
  69.     public function __construct(
  70.         AbstractCmsRoute $cmsRoute,
  71.         AbstractCategoryRoute $categoryRoute,
  72.         AbstractProductListingRoute $listingRoute,
  73.         AbstractProductDetailRoute $productRoute,
  74.         ProductReviewLoader $productReviewLoader,
  75.         ProductCombinationFinder $combinationFinder,
  76.         EventDispatcherInterface $eventDispatcher
  77.     ) {
  78.         $this->cmsRoute = $cmsRoute;
  79.         $this->categoryRoute = $categoryRoute;
  80.         $this->listingRoute = $listingRoute;
  81.         $this->productRoute = $productRoute;
  82.         $this->productReviewLoader = $productReviewLoader;
  83.         $this->combinationFinder = $combinationFinder;
  84.         $this->eventDispatcher = $eventDispatcher;
  85.     }
  87.     /**
  88.      * @Since("6.0.0.0")
  89.      * Route for cms data (used in XmlHttpRequest)
  90.      *
  91.      * @HttpCache()
  92.      * @Route("/widgets/cms/{id}", name="frontend.cms.page", methods={"GET", "POST"}, defaults={"id"=null, "XmlHttpRequest"=true})
  93.      */
  94.     public function page(?string $id, Request $request, SalesChannelContext $salesChannelContext): Response
  95.     {
  96.         if (!$id) {
  97.             throw new MissingRequestParameterException('Parameter id missing');
  98.         }
  100.         $page = $this->cmsRoute->load($id, $request, $salesChannelContext)->getCmsPage();
  102.         $this->hook(new CmsPageLoadedHook($page, $salesChannelContext));
  104.         $response = $this->renderStorefront('@Storefront/storefront/page/content/detail.html.twig', ['cmsPage' => $page]);
  105.         $response->headers->set('x-robots-tag', 'noindex');
  107.         return $response;
  108.     }
  110.     /**
  111.      * @Since("6.0.0.0")
  112.      * Route to load a cms page which assigned to the provided navigation id.
  113.      * Navigation id is required to load the slot config for the navigation
  114.      *
  115.      * @Route("/widgets/cms/navigation/{navigationId}", name="frontend.cms.navigation.page", methods={"GET", "POST"}, defaults={"navigationId"=null, "XmlHttpRequest"=true})
  116.      */
  117.     public function category(?string $navigationId, Request $request, SalesChannelContext $salesChannelContext): Response
  118.     {
  119.         if (!$navigationId) {
  120.             throw new MissingRequestParameterException('Parameter navigationId missing');
  121.         }
  123.         $category = $this->categoryRoute->load($navigationId, $request, $salesChannelContext)->getCategory();
  125.         $page = $category->getCmsPage();
  126.         if (!$page) {
  127.             throw new PageNotFoundException('');
  128.         }
  130.         $this->hook(new CmsPageLoadedHook($page, $salesChannelContext));
  132.         $response = $this->renderStorefront('@Storefront/storefront/page/content/detail.html.twig', ['cmsPage' => $page]);
  133.         $response->headers->set('x-robots-tag', 'noindex');
  135.         return $response;
  136.     }
  138.     /**
  139.      * @Since("6.0.0.0")
  140.      * @HttpCache()
  141.      *
  142.      * Route to load the listing filters
  143.      *
  144.      * @Route("/widgets/cms/navigation/{navigationId}/filter", name="frontend.cms.navigation.filter", methods={"GET", "POST"}, defaults={"XmlHttpRequest"=true, "_routeScope"={"storefront"}})
  145.      */
  146.     public function filter(string $navigationId, Request $request, SalesChannelContext $context): Response
  147.     {
  148.         if (!$navigationId) {
  149.             throw new MissingRequestParameterException('Parameter navigationId missing');
  150.         }
  152.         // Allows to fetch only aggregations over the gateway.
  153.         $request->request->set('only-aggregations', true);
  155.         // Allows to convert all post-filters to filters. This leads to the fact that only aggregation values are returned, which are combinable with the previous applied filters.
  156.         $request->request->set('reduce-aggregations', true);
  158.         $listing = $this->listingRoute
  159.             ->load($navigationId, $request, $context, new Criteria())
  160.             ->getResult();
  162.         $mapped = [];
  163.         foreach ($listing->getAggregations() as $aggregation) {
  164.             $mapped[$aggregation->getName()] = $aggregation;
  165.         }
  167.         $response = new JsonResponse($mapped);
  168.         $response->headers->set(AbstractSessionListener::NO_AUTO_CACHE_CONTROL_HEADER, '1');
  169.         $response->headers->set('x-robots-tag', 'noindex');
  171.         return $response;
  172.     }
  174.     /**
  175.      * @Since("6.4.0.0")
  176.      * @HttpCache()
  177.      *
  178.      * Route to load the cms element buy box product config which assigned to the provided product id.
  179.      * Product id is required to load the slot config for the buy box
  180.      *
  181.      * @Route("/widgets/cms/buybox/{productId}/switch", name="frontend.cms.buybox.switch", methods={"GET"}, defaults={"productId"=null, "XmlHttpRequest"=true, "_routeScope"={"storefront"}})
  182.      */
  183.     public function switchBuyBoxVariant(string $productId, Request $request, SalesChannelContext $context): Response
  184.     {
  185.         if (!$productId) {
  186.             throw new MissingRequestParameterException('Parameter productId missing');
  187.         }
  189.         /** @var string $switchedOption */
  190.         $switchedOption = $request->query->get('switched');
  192.         /** @var string $elementId */
  193.         $elementId = $request->query->get('elementId');
  195.         $options = (string) $request->query->get('options');
  196.         /** @var array $newOptions */
  197.         $newOptions = \strlen($options) ? json_decode($options, true) : [];
  199.         $redirect = $this->combinationFinder->find($productId, $switchedOption, $newOptions, $context);
  201.         $newProductId = $redirect->getVariantId();
  203.         $result = $this->productRoute->load($newProductId, $request, $context, new Criteria());
  204.         $product = $result->getProduct();
  205.         $configurator = $result->getConfigurator();
  207.         $request->request->set('parentId', $product->getParentId());
  208.         $request->request->set('productId', $product->getId());
  209.         $reviews = $this->productReviewLoader->load($request, $context);
  210.         $reviews->setParentId($product->getParentId() ?? $product->getId());
  212.         $event = new SwitchBuyBoxVariantEvent($elementId, $product, $configurator, $request, $context);
  213.         $this->eventDispatcher->dispatch($event);
  215.         $response = $this->renderStorefront('@Storefront/storefront/component/buy-widget/buy-widget.html.twig', [
  216.             'product' => $product,
  217.             'configuratorSettings' => $configurator,
  218.             'totalReviews' => $reviews->getTotalReviews(),
  219.             'elementId' => $elementId,
  220.         ]);
  221.         $response->headers->set('x-robots-tag', 'noindex');
  223.         return $response;
  224.     }
  225. }