vendor/shopware/core/Content/Category/SalesChannel/TreeBuildingNavigationRoute.php line 102

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Category\SalesChannel;
  5. use OpenApi\Annotations as OA;
  6. use Shopware\Core\Content\Category\CategoryCollection;
  7. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  8. use Shopware\Core\Framework\Routing\Annotation\Entity;
  9. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  10. use Shopware\Core\Framework\Routing\Annotation\Since;
  11. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  12. use Shopware\Core\System\SalesChannel\SalesChannelEntity;
  13. use Symfony\Component\HttpFoundation\Request;
  14. use Symfony\Component\Routing\Annotation\Route;
  16. /**
  17.  * @Route(defaults={"_routeScope"={"store-api"}})
  18.  */
  19. class TreeBuildingNavigationRoute extends AbstractNavigationRoute
  20. {
  21.     private AbstractNavigationRoute $decorated;
  23.     /**
  24.      * @internal
  25.      */
  26.     public function __construct(AbstractNavigationRoute $decorated)
  27.     {
  28.         $this->decorated = $decorated;
  29.     }
  31.     public function getDecorated(): AbstractNavigationRoute
  32.     {
  33.         return $this->decorated;
  34.     }
  36.     /**
  37.      * @Since("6.2.0.0")
  38.      * @Entity("category")
  39.      * @OA\Post(
  40.      *      path="/navigation/{requestActiveId}/{requestRootId}",
  41.      *      summary="Fetch a navigation menu",
  42.      *      description="This endpoint returns categories that can be used as a page navigation. You can either return them as a tree or as a flat list. You can also control the depth of the tree.
  44.     Instead of passing uuids, you can also use one of the following aliases for the activeId and rootId parameters to get the respective navigations of your sales channel.
  46.      * main-navigation
  47.      * service-navigation
  48.      * footer-navigation",
  49.      *      operationId="readNavigation",
  50.      *      tags={"Store API", "Category"},
  51.      *      @OA\Parameter(name="Api-Basic-Parameters"),
  52.      *      @OA\Parameter(
  53.      *          name="sw-include-seo-urls",
  54.      *          description="Instructs Shopware to try and resolve SEO URLs for the given navigation item",
  55.      *          @OA\Schema(type="boolean"),
  56.      *          in="header",
  57.      *          required=false
  58.      *      ),
  59.      *      @OA\Parameter(
  60.      *          name="requestActiveId",
  61.      *          description="Identifier of the active category in the navigation tree (if not used, just set to the same as rootId).",
  62.      *          @OA\Schema(type="string", pattern="^[0-9a-f]{32}$"),
  63.      *          in="path",
  64.      *          required=true
  65.      *      ),
  66.      *      @OA\Parameter(
  67.      *          name="requestRootId",
  68.      *          description="Identifier of the root category for your desired navigation tree. You can use it to fetch sub-trees of your navigation tree.",
  69.      *          @OA\Schema(type="string", pattern="^[0-9a-f]{32}$"),
  70.      *          in="path",
  71.      *          required=true
  72.      *      ),
  73.      *      @OA\RequestBody(
  74.      *          required=true,
  75.      *          @OA\JsonContent(
  76.      *              @OA\Property(
  77.      *                  property="depth",
  78.      *                  description="Determines the depth of fetched navigation levels.",
  79.      *                  @OA\Schema(type="integer", default="2")
  80.      *              ),
  81.      *              @OA\Property(
  82.      *                  property="buildTree",
  83.      *                  description="Return the categories as a tree or as a flat list.",
  84.      *                  @OA\Schema(type="boolean", default="true")
  85.      *              )
  86.      *          )
  87.      *      ),
  88.      *      @OA\Response(
  89.      *          response="200",
  90.      *          description="All available navigations",
  91.      *          @OA\JsonContent(ref="#/components/schemas/NavigationRouteResponse")
  92.      *     )
  93.      * )
  94.      * @Route("/store-api/navigation/{activeId}/{rootId}", name="store-api.navigation", methods={"GET", "POST"})
  95.      */
  96.     public function load(string $activeId, string $rootId, Request $request, SalesChannelContext $context, Criteria $criteria): NavigationRouteResponse
  97.     {
  98.         $activeId = $this->resolveAliasId($activeId, $context->getSalesChannel());
  100.         $rootId = $this->resolveAliasId($rootId, $context->getSalesChannel());
  102.         $response = $this->getDecorated()->load($activeId, $rootId, $request, $context, $criteria);
  104.         $buildTree = $request->query->getBoolean('buildTree', $request->request->getBoolean('buildTree', true));
  106.         if (!$buildTree) {
  107.             return $response;
  108.         }
  110.         $categories = $this->buildTree($rootId, $response->getCategories()->getElements());
  112.         return new NavigationRouteResponse($categories);
  113.     }
  115.     private function buildTree(?string $parentId, array $categories): CategoryCollection
  116.     {
  117.         $children = new CategoryCollection();
  118.         foreach ($categories as $key => $category) {
  119.             if ($category->getParentId() !== $parentId) {
  120.                 continue;
  121.             }
  123.             unset($categories[$key]);
  125.             $children->add($category);
  126.         }
  128.         $children->sortByPosition();
  130.         $items = new CategoryCollection();
  131.         foreach ($children as $child) {
  132.             if (!$child->getActive() || !$child->getVisible()) {
  133.                 continue;
  134.             }
  136.             $child->setChildren($this->buildTree($child->getId(), $categories));
  138.             $items->add($child);
  139.         }
  141.         return $items;
  142.     }
  144.     private function resolveAliasId(string $id, SalesChannelEntity $salesChannelEntity): string
  145.     {
  146.         switch ($id) {
  147.             case 'main-navigation':
  148.                 return $salesChannelEntity->getNavigationCategoryId();
  149.             case 'service-navigation':
  150.                 if ($salesChannelEntity->getServiceCategoryId() === null) {
  151.                     throw new \RuntimeException(\sprintf('Service category, for sales channel %s, is not set', $salesChannelEntity->getTranslation('name')));
  152.                 }
  154.                 return $salesChannelEntity->getServiceCategoryId();
  155.             case 'footer-navigation':
  156.                 if ($salesChannelEntity->getFooterCategoryId() === null) {
  157.                     throw new \RuntimeException('Footer category, for sales channel %s, is not set', $salesChannelEntity->getTranslation('name'));
  158.                 }
  160.                 return $salesChannelEntity->getFooterCategoryId();
  161.             default:
  162.                 return $id;
  163.         }
  164.     }
  165. }