platform/src/Core/Content/Category/SalesChannel/CategoryListRoute.php line 65

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\Framework\DataAbstractionLayer\Search\Criteria;
  7. use Shopware\Core\Framework\Plugin\Exception\DecorationPatternException;
  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\Entity\SalesChannelRepositoryInterface;
  12. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  13. use Symfony\Component\Routing\Annotation\Route;
  15. /**
  16.  * @RouteScope(scopes={"store-api"})
  17.  */
  18. class CategoryListRoute extends AbstractCategoryListRoute
  19. {
  20.     /**
  21.      * @var SalesChannelRepositoryInterface
  22.      */
  23.     private $categoryRepository;
  25.     public function __construct(SalesChannelRepositoryInterface $categoryRepository)
  26.     {
  27.         $this->categoryRepository = $categoryRepository;
  28.     }
  30.     public function getDecorated(): AbstractCategoryListRoute
  31.     {
  32.         throw new DecorationPatternException(self::class);
  33.     }
  35.     /**
  36.      * @Since("6.3.2.0")
  37.      * @Entity("category")
  38.      * @OA\Post(
  39.      *      path="/category",
  40.      *      summary="Fetch a list of categories",
  41.      *      description="Perform a filtered search for categories.",
  42.      *      operationId="readCategoryList",
  43.      *      tags={"Store API", "Category"},
  44.      *      @OA\Parameter(name="Api-Basic-Parameters"),
  45.      *      @OA\Response(
  46.      *          response="200",
  47.      *          description="Entity search result containing categories.",
  48.      *          @OA\JsonContent(
  49.      *              type="object",
  50.      *              allOf={
  51.      *                  @OA\Schema(ref="#/components/schemas/EntitySearchResult"),
  52.      *                  @OA\Schema(type="object",
  53.      *                      @OA\Property(
  54.      *                          type="array",
  55.      *                          property="elements",
  56.      *                          @OA\Items(ref="#/components/schemas/Category")
  57.      *                      )
  58.      *                  )
  59.      *              }
  60.      *          )
  61.      *     )
  62.      * )
  63.      * @Route("/store-api/category", name="store-api.category.search", methods={"GET", "POST"})
  64.      */
  65.     public function load(Criteria $criteria, SalesChannelContext $context): CategoryListRouteResponse
  66.     {
  67.         return new CategoryListRouteResponse($this->categoryRepository->search($criteria, $context));
  68.     }
  69. }