vendor/shopware/core/Content/Product/SalesChannel/Listing/ResolveCriteriaProductListingRoute.php line 72

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Product\SalesChannel\Listing;
  5. use OpenApi\Annotations as OA;
  6. use Shopware\Core\Content\Product\Events\ProductListingCriteriaEvent;
  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 Symfony\Component\HttpFoundation\Request;
  13. use Symfony\Component\Routing\Annotation\Route;
  14. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  16. /**
  17.  * @Route(defaults={"_routeScope"={"store-api"}})
  18.  */
  19. class ResolveCriteriaProductListingRoute extends AbstractProductListingRoute
  20. {
  21.     private AbstractProductListingRoute $decorated;
  23.     private EventDispatcherInterface $eventDispatcher;
  25.     /**
  26.      * @internal
  27.      */
  28.     public function __construct(AbstractProductListingRoute $decorated, EventDispatcherInterface $eventDispatcher)
  29.     {
  30.         $this->decorated = $decorated;
  31.         $this->eventDispatcher = $eventDispatcher;
  32.     }
  34.     public function getDecorated(): AbstractProductListingRoute
  35.     {
  36.         return $this->decorated;
  37.     }
  39.     /**
  40.      * @Since("6.2.0.0")
  41.      * @Entity("product")
  42.      * @OA\Post(
  43.      *      path="/product-listing/{categoryId}",
  44.      *      summary="Fetch a product listing by category",
  45.      *      description="Fetches a product listing for a specific category. It also provides filters, sortings and property aggregations, analogous to the /search endpoint.",
  46.      *      operationId="readProductListing",
  47.      *      tags={"Store API","Product"},
  48.      *      @OA\RequestBody(
  49.      *          @OA\JsonContent(
  50.      *                  type="object",
  51.      *                  allOf={
  52.      *                      @OA\Schema(ref="#/components/schemas/ProductListingCriteria"),
  53.      *                      @OA\Schema(ref="#/components/schemas/ProductListingFlags")
  54.      *                  }
  55.      *          )
  56.      *      ),
  57.      *      @OA\Parameter(
  58.      *          name="categoryId",
  59.      *          description="Identifier of a category.",
  60.      *          @OA\Schema(type="string"),
  61.      *          in="path",
  62.      *          required=true
  63.      *      ),
  64.      *      @OA\Response(
  65.      *          response="200",
  66.      *          description="Returns a product listing containing all products and additional fields to display a listing.",
  67.      *          @OA\JsonContent(ref="#/components/schemas/ProductListingResult")
  68.      *     )
  69.      * )
  70.      * @Route("/store-api/product-listing/{categoryId}", name="store-api.product.listing", methods={"POST"})
  71.      */
  72.     public function load(string $categoryId, Request $request, SalesChannelContext $context, Criteria $criteria): ProductListingRouteResponse
  73.     {
  74.         $this->eventDispatcher->dispatch(
  75.             new ProductListingCriteriaEvent($request, $criteria, $context)
  76.         );
  78.         return $this->getDecorated()->load($categoryId, $request, $context, $criteria);
  79.     }
  80. }