如何在 API 平台 GET 操作中始终根据特定字段值过滤集合?

Question

在GET操作中，我想从返回的集合中排除我的实体，这些实体的"存档"字段等于" true"。

我希望这是我的端点(如/users或/companies(的默认设置，我想避免手动添加 URL 过滤器，例如/users?filter[archive]=true

最好的方法是什么？

感谢您的任何帮助:)

Answer 1

我不得不做类似的事情，我通过将 DoctrineExtension 应用于将 WHERE 子句添加到 QueryBuilder 的集合来解决它。

如何？

1. 定义你的过滤器，我看到你已经有了。
2. 将原则扩展添加到 仅应用于收藏，或者如果需要，也可以应用于项目：https://api-platform.com/docs/core/extensions/#custom-doctrine-orm-extension

services:
AppDoctrineExtensionArchivedExtension:
tags:
- { name: api_platform.doctrine.orm.query_extension.collection }

3. 编写扩展代码。

您可以检查是否收到某个"过滤器"(您的"filter[archive]=true"查询参数(：如果是，请不要将条件应用于 QueryBuilder，您的过滤器将由 ApiPlatform 的过滤机制应用。

扩展类应如下所示：

class ArchivedExtension implements QueryCollectionExtensionInterface
{
public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null, array $context = [])
{
$this->addWhere($queryBuilder, $resourceClass, $context);
}
private function addWhere(QueryBuilder $queryBuilder, string $resourceClass, array $context = [])
{
if (MyResource::class !== $resourceClass) {
return;
}
// Search if a "archive" Filter is being requested, if not, apply a restriction to the QueryBuilder
if (array_key_exists('archive', $context['filters'])) {
return;
}
$rootAlias = $queryBuilder->getRootAliases()[0];
$queryBuilder->andWhere(sprintf('%s.archive = :archive', $rootAlias));
$queryBuilder->setParameter('archive', true);
}
}