在API Platform中为嵌套实体创建自定义筛选器端点

{
    "brands": [
        "Agilent",
        "Comtr",
        "Anot"
    ],
    "types": [
        "Accelerometer",
        "Sonometer",
        "Micro-amplifier"
    ]
}

<?php

namespace App\Entity;

use ApiPlatform\Core\Annotation\ApiResource;
use App\Repository\ProductModelRepository;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Serializer\Annotation\Groups;

/**
 * @ORM\Entity(repositoryClass=ProductModelRepository::class)
 * @ApiResource(
 *     itemOperations={"get"},
 *     collectionOperations={
 *          "get",
 *          "filters"={
 *             "method"="GET",
 *             "path"="/product_models/filters",
 *             "controller"=App\Controller\Action\DistinctFiltersAction::class,
 *             "openapi_context"={
 *                 "summary"="获取所有产品模型中唯一的品牌和产品类型",
 *                 "parameters"={}
 *             },
 *             "read"=false, // 表示此操作不用于获取单个资源
 *          }
 *     },
 *     normalizationContext={
 *     "groups"={"read"}}
 * )
 */
class ProductModel
{
    // ... 实体属性和方法
}

<?php

namespace App\Repository;

use App\Entity\ProductModel;
use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
use Doctrine\Persistence\ManagerRegistry;

/**
 * @method ProductModel|null find($id, $lockMode = null, $lockVersion = null)
 * @method ProductModel|null findOneBy(array $criteria, array $orderBy = null)
 * @method ProductModel[]    findAll()
 * @method ProductModel[]    findBy(array $criteria, array $orderBy = null, $limit = null, $offset = null)
 */
class ProductModelRepository extends ServiceEntityRepository
{
    public function __construct(ManagerRegistry $registry)
    {
        parent::__construct($registry, ProductModel::class);
    }

    /**
     * 获取所有独特的品牌名称列表。
     * 假设 Brand 实体有一个 'name' 属性。
     *
     * @return array
     */
    public function getDistinctBrands(): array
    {
        return $this->createQueryBuilder('pm')
            ->select('b.name') // 选择 Brand 实体的名称属性
            ->join('pm.idBrand', 'b') // 通过 idBrand 关联到 Brand 实体
            ->groupBy('b.name') // 按品牌名称分组以获取唯一值
            ->getQuery()
            ->getSingleColumnResult(); // 返回一个简单的字符串数组
    }

    /**
     * 获取所有独特的产品类型名称列表。
     * 假设 ProductType 实体有一个 'name' 属性。
     *
     * @return array
     */
    public function getDistinctProductTypes(): array
    {
        return $this->createQueryBuilder('pm')
            ->select('pt.name') // 选择 ProductType 实体的名称属性
            ->join('pm.idProductType', 'pt') // 通过 idProductType 关联到 ProductType 实体
            ->groupBy('pt.name') // 按产品类型名称分组以获取唯一值
            ->getQuery()
            ->getSingleColumnResult(); // 返回一个简单的字符串数组
    }
}

<?php

namespace App\Controller\Action;

use App\Repository\ProductModelRepository;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\Routing\Annotation\Route;

/**
 * Class DistinctFiltersAction
 * @Route(
 *     path="/product_models/filters",
 *     methods={"GET"},
 *     defaults={"_api_resource_class"=ProductModel::class, "_api_collection_operation_name"="filters"}
 * )
 */
final class DistinctFiltersAction extends AbstractController
{
    /**
     * 处理获取独特品牌和产品类型列表的请求。
     *
     * @param ProductModelRepository $productModelRepository
     * @return JsonResponse
     */
    public function __invoke(ProductModelRepository $productModelRepository): JsonResponse
    {
        // 调用仓库方法获取独特的品牌和产品类型
        $brands = $productModelRepository->getDistinctBrands();
        $types = $productModelRepository->getDistinctProductTypes();

        // 将结果格式化为所需的JSON结构并返回
        return new JsonResponse([
            'brands' => $brands,
            'types' => $types,
        ]);
    }
}