告别繁琐：使用LaminasAPIToolsDoctrineQueryBuilder轻松构建API过滤器-composer-PHP中文网

告别繁琐：使用LaminasAPIToolsDoctrineQueryBuilder轻松构建API过滤器

花韻仙語

发布： 2025-11-16 19:21:01

原创

361人浏览过

告别繁琐：使用laminasapitoolsdoctrinequerybuilder轻松构建api过滤器

在构建 RESTful API 时，我们经常需要根据客户端传递的参数来过滤和排序数据。例如，用户可能需要根据名称、日期范围或其他条件来筛选商品列表。手动编写这些过滤逻辑不仅耗时，而且容易引入错误。此外，如果 API 需要支持更复杂的查询条件，代码的维护成本也会随之增加。

Laminas API Tools Doctrine QueryBuilder 模块旨在解决这个问题。它提供了一种声明式的方式来定义查询过滤器和排序规则，并通过简单的配置和请求参数，即可实现复杂的查询过滤功能。这意味着开发者可以专注于业务逻辑的实现，而无需花费大量时间编写重复的查询代码。

Composer在线学习地址：学习地址

安装与配置

首先，使用 Composer 安装该模块：

<code>$ composer require laminas-api-tools/api-tools-doctrine-querybuilder</code>

登录后复制

然后，将 Laminas\ApiTools\Doctrine\QueryBuilder 添加到 config/application.config.php 中的模块列表中。

接下来，复制 config/api-tools-doctrine-querybuilder.global.php.dist 到 config/autoload/api-tools-doctrine-querybuilder.global.php，并根据需要编辑配置。

使用示例

假设我们有一个 User 实体，包含 id、name、startAt 和 endAt 等字段。我们可以配置模块，以便通过 $_GET['filter'] 和 $_GET['order-by'] 请求参数来过滤和排序用户数据。

轻幕

轻幕是一个综合性短视频制作平台，诗词、故事、小说等一键成片转视频，让内容传播更生动！

查看详情

以下是一个配置示例：

<pre class="brush:php;toolbar:false;">'api-tools-doctrine-querybuilder-orderby-orm' => [
    'aliases' => [
        'field' => \Laminas\ApiTools\Doctrine\QueryBuilder\OrderBy\ORM\Field::class,
    ],
    'factories' => [
        \Laminas\ApiTools\Doctrine\QueryBuilder\OrderBy\ORM\Field::class => \Laminas\ServiceManager\Factory\InvokableFactory::class,
    ],
],
'api-tools-doctrine-querybuilder-filter-orm' => [
    'aliases' => [
        'eq' => \Laminas\ApiTools\Doctrine\QueryBuilder\Filter\ORM\Equals::class,
    ],
    'factories' => [
        \Laminas\ApiTools\Doctrine\QueryBuilder\Filter\ORM\Equals::class => \Laminas\ServiceManager\Factory\InvokableFactory::class,
    ],
],

登录后复制

以下是一个请求示例，用于过滤名称为 "Tom" 的用户，并按 startAt 字段降序排序：

<pre class="brush:php;toolbar:false;">$_GET = [
    'filter' => [
        [
            'type'  => 'eq',
            'field' => 'name',
            'value' => 'Tom',
        ],
    ],
    'order-by' => [
        [
            'type'      => 'field',
            'field'     => 'startAt',
            'direction' => 'desc',
        ],
    ],
];

登录后复制

优势与应用

Laminas API Tools Doctrine QueryBuilder 模块具有以下优势：