vendor/shopware/platform/src/Storefront/Controller/CmsController.php line 89

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. class CmsController extends StorefrontController
  31. {
  32.     /**
  33.      * @var AbstractCmsRoute
  34.      */
  35.     private $cmsRoute;
  37.     /**
  38.      * @var AbstractCategoryRoute
  39.      */
  40.     private $categoryRoute;
  42.     /**
  43.      * @var AbstractProductListingRoute
  44.      */
  45.     private $listingRoute;
  47.     /**
  48.      * @var AbstractProductDetailRoute
  49.      */
  50.     private $productRoute;
  52.     /**
  53.      * @var ProductReviewLoader
  54.      */
  55.     private $productReviewLoader;
  57.     /**
  58.      * @var ProductCombinationFinder
  59.      */
  60.     private $combinationFinder;
  62.     private EventDispatcherInterface $eventDispatcher;
  64.     public function __construct(
  65.         AbstractCmsRoute $cmsRoute,
  66.         AbstractCategoryRoute $categoryRoute,
  67.         AbstractProductListingRoute $listingRoute,
  68.         AbstractProductDetailRoute $productRoute,
  69.         ProductReviewLoader $productReviewLoader,
  70.         ProductCombinationFinder $combinationFinder,
  71.         EventDispatcherInterface $eventDispatcher
  72.     ) {
  73.         $this->cmsRoute = $cmsRoute;
  74.         $this->categoryRoute = $categoryRoute;
  75.         $this->listingRoute = $listingRoute;
  76.         $this->productRoute = $productRoute;
  77.         $this->productReviewLoader = $productReviewLoader;
  78.         $this->combinationFinder = $combinationFinder;
  79.         $this->eventDispatcher = $eventDispatcher;
  80.     }
  82.     /**
  83.      * @Since("6.0.0.0")
  84.      * Route for cms data (used in XmlHttpRequest)
  85.      *
  86.      * @HttpCache()
  87.      * @Route("/widgets/cms/{id}", name="frontend.cms.page", methods={"GET", "POST"}, defaults={"id"=null, "XmlHttpRequest"=true})
  88.      */
  89.     public function page(?string $id, Request $request, SalesChannelContext $salesChannelContext): Response
  90.     {
  91.         if (!$id) {
  92.             throw new MissingRequestParameterException('Parameter id missing');
  93.         }
  95.         $page = $this->cmsRoute->load($id, $request, $salesChannelContext)->getCmsPage();
  97.         $this->hook(new CmsPageLoadedHook($page, $salesChannelContext));
  99.         $response = $this->renderStorefront('@Storefront/storefront/page/content/detail.html.twig', ['cmsPage' => $page]);
  100.         $response->headers->set('x-robots-tag', 'noindex');
  102.         return $response;
  103.     }
  105.     /**
  106.      * @Since("6.0.0.0")
  107.      * Route to load a cms page which assigned to the provided navigation id.
  108.      * Navigation id is required to load the slot config for the navigation
  109.      *
  110.      * @Route("/widgets/cms/navigation/{navigationId}", name="frontend.cms.navigation.page", methods={"GET", "POST"}, defaults={"navigationId"=null, "XmlHttpRequest"=true})
  111.      */
  112.     public function category(?string $navigationId, Request $request, SalesChannelContext $salesChannelContext): Response
  113.     {
  114.         if (!$navigationId) {
  115.             throw new MissingRequestParameterException('Parameter navigationId missing');
  116.         }
  118.         $category = $this->categoryRoute->load($navigationId, $request, $salesChannelContext)->getCategory();
  120.         $page = $category->getCmsPage();
  121.         if (!$page) {
  122.             throw new PageNotFoundException('');
  123.         }
  125.         $this->hook(new CmsPageLoadedHook($page, $salesChannelContext));
  127.         $response = $this->renderStorefront('@Storefront/storefront/page/content/detail.html.twig', ['cmsPage' => $page]);
  128.         $response->headers->set('x-robots-tag', 'noindex');
  130.         return $response;
  131.     }
  133.     /**
  134.      * @Since("6.0.0.0")
  135.      * @HttpCache()
  136.      *
  137.      * Route to load the listing filters
  138.      *
  139.      * @Route("/widgets/cms/navigation/{navigationId}/filter", name="frontend.cms.navigation.filter", methods={"GET", "POST"}, defaults={"XmlHttpRequest"=true, "_routeScope"={"storefront"}})
  140.      */
  141.     public function filter(string $navigationId, Request $request, SalesChannelContext $context): Response
  142.     {
  143.         if (!$navigationId) {
  144.             throw new MissingRequestParameterException('Parameter navigationId missing');
  145.         }
  147.         // Allows to fetch only aggregations over the gateway.
  148.         $request->request->set('only-aggregations', true);
  150.         // 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.
  151.         $request->request->set('reduce-aggregations', true);
  153.         $listing = $this->listingRoute
  154.             ->load($navigationId, $request, $context, new Criteria())
  155.             ->getResult();
  157.         $mapped = [];
  158.         foreach ($listing->getAggregations() as $aggregation) {
  159.             $mapped[$aggregation->getName()] = $aggregation;
  160.         }
  162.         $response = new JsonResponse($mapped);
  163.         $response->headers->set(AbstractSessionListener::NO_AUTO_CACHE_CONTROL_HEADER, '1');
  164.         $response->headers->set('x-robots-tag', 'noindex');
  166.         return $response;
  167.     }
  169.     /**
  170.      * @Since("6.4.0.0")
  171.      * @HttpCache()
  172.      *
  173.      * Route to load the cms element buy box product config which assigned to the provided product id.
  174.      * Product id is required to load the slot config for the buy box
  175.      *
  176.      * @Route("/widgets/cms/buybox/{productId}/switch", name="frontend.cms.buybox.switch", methods={"GET"}, defaults={"productId"=null, "XmlHttpRequest"=true, "_routeScope"={"storefront"}})
  177.      */
  178.     public function switchBuyBoxVariant(string $productId, Request $request, SalesChannelContext $context): Response
  179.     {
  180.         if (!$productId) {
  181.             throw new MissingRequestParameterException('Parameter productId missing');
  182.         }
  184.         /** @var string $switchedOption */
  185.         $switchedOption = $request->query->get('switched');
  187.         /** @var string $elementId */
  188.         $elementId = $request->query->get('elementId');
  190.         $options = (string) $request->query->get('options');
  191.         /** @var array $newOptions */
  192.         $newOptions = \strlen($options) ? json_decode($options, true) : [];
  194.         $redirect = $this->combinationFinder->find($productId, $switchedOption, $newOptions, $context);
  196.         $newProductId = $redirect->getVariantId();
  198.         $result = $this->productRoute->load($newProductId, $request, $context, new Criteria());
  199.         $product = $result->getProduct();
  200.         $configurator = $result->getConfigurator();
  202.         $request->request->set('parentId', $product->getParentId());
  203.         $request->request->set('productId', $product->getId());
  204.         $reviews = $this->productReviewLoader->load($request, $context);
  205.         $reviews->setParentId($product->getParentId() ?? $product->getId());
  207.         $event = new SwitchBuyBoxVariantEvent($elementId, $product, $configurator, $request, $context);
  208.         $this->eventDispatcher->dispatch($event);
  210.         $response = $this->renderStorefront('@Storefront/storefront/component/buy-widget/buy-widget.html.twig', [
  211.             'product' => $product,
  212.             'configuratorSettings' => $configurator,
  213.             'totalReviews' => $reviews->getTotalReviews(),
  214.             'elementId' => $elementId,
  215.         ]);
  216.         $response->headers->set('x-robots-tag', 'noindex');
  218.         return $response;
  219.     }
  220. }