Skip to content

Commit 68d2dfb

Browse files
vinceAmstoutzvinceAmstoutz
committed
feat(doctrine): doctrine filters like laravel eloquent filters
1 parent b458b55 commit 68d2dfb

38 files changed

+1672
-59
lines changed

Diff for: ‎src/Doctrine/Common/Filter/ManagerRegistryAwareInterface.php

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the API Platform project.
5+
*
6+
* (c) Kévin Dunglas <[email protected]>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
declare(strict_types=1);
13+
14+
namespace ApiPlatform\Doctrine\Common\Filter;
15+
16+
use Doctrine\Persistence\ManagerRegistry;
17+
18+
interface ManagerRegistryAwareInterface
19+
{
20+
public function hasManagerRegistry(): bool;
21+
22+
public function getManagerRegistry(): ManagerRegistry;
23+
24+
public function setManagerRegistry(ManagerRegistry $managerRegistry): void;
25+
}

Diff for: ‎src/Doctrine/Odm/Extension/ParameterExtension.php

+36-11
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,13 @@
1313

1414
namespace ApiPlatform\Doctrine\Odm\Extension;
1515

16+
use ApiPlatform\Doctrine\Common\Filter\ManagerRegistryAwareInterface;
1617
use ApiPlatform\Doctrine\Common\ParameterValueExtractorTrait;
18+
use ApiPlatform\Doctrine\Odm\Filter\AbstractFilter;
1719
use ApiPlatform\Doctrine\Odm\Filter\FilterInterface;
1820
use ApiPlatform\Metadata\Operation;
1921
use ApiPlatform\State\ParameterNotFound;
22+
use Doctrine\Bundle\MongoDBBundle\ManagerRegistry;
2023
use Doctrine\ODM\MongoDB\Aggregation\Builder;
2124
use Psr\Container\ContainerInterface;
2225

@@ -29,14 +32,20 @@ final class ParameterExtension implements AggregationCollectionExtensionInterfac
2932
{
3033
use ParameterValueExtractorTrait;
3134

32-
public function __construct(private readonly ContainerInterface $filterLocator)
33-
{
35+
public function __construct(
36+
private readonly ContainerInterface $filterLocator,
37+
private readonly ?ManagerRegistry $managerRegistry = null,
38+
) {
3439
}
3540

41+
/**
42+
* @param array<string, mixed> $context
43+
*/
3644
private function applyFilter(Builder $aggregationBuilder, ?string $resourceClass = null, ?Operation $operation = null, array &$context = []): void
3745
{
3846
foreach ($operation->getParameters() ?? [] as $parameter) {
39-
if (!($v = $parameter->getValue()) || $v instanceof ParameterNotFound) {
47+
// TODO: remove the null equality as a parameter can have a null value
48+
if (null === ($v = $parameter->getValue()) || $v instanceof ParameterNotFound) {
4049
continue;
4150
}
4251

@@ -45,14 +54,30 @@ private function applyFilter(Builder $aggregationBuilder, ?string $resourceClass
4554
continue;
4655
}
4756

48-
$filter = $this->filterLocator->has($filterId) ? $this->filterLocator->get($filterId) : null;
49-
if ($filter instanceof FilterInterface) {
50-
$filterContext = ['filters' => $values, 'parameter' => $parameter];
51-
$filter->apply($aggregationBuilder, $resourceClass, $operation, $filterContext);
52-
// update by reference
53-
if (isset($filterContext['mongodb_odm_sort_fields'])) {
54-
$context['mongodb_odm_sort_fields'] = $filterContext['mongodb_odm_sort_fields'];
55-
}
57+
$filter = match (true) {
58+
$filterId instanceof FilterInterface => $filterId,
59+
\is_string($filterId) && $this->filterLocator->has($filterId) => $this->filterLocator->get($filterId),
60+
default => null,
61+
};
62+
63+
if (!$filter instanceof FilterInterface) {
64+
continue;
65+
}
66+
67+
if ($filter instanceof ManagerRegistryAwareInterface && !$filter->hasManagerRegistry()) {
68+
$filter->setManagerRegistry($this->managerRegistry);
69+
}
70+
71+
if ($filter instanceof AbstractFilter && !$filter->getProperties()) {
72+
$propertyKey = $parameter->getProperty() ?? $parameter->getKey();
73+
$filter->setProperties([$propertyKey => $parameter->getFilterContext()]);
74+
}
75+
76+
$filterContext = ['filters' => $values, 'parameter' => $parameter];
77+
$filter->apply($aggregationBuilder, $resourceClass, $operation, $filterContext);
78+
// update by reference
79+
if (isset($filterContext['mongodb_odm_sort_fields'])) {
80+
$context['mongodb_odm_sort_fields'] = $filterContext['mongodb_odm_sort_fields'];
5681
}
5782
}
5883
}

Diff for: ‎src/Doctrine/Odm/Filter/AbstractFilter.php

+29-6
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@
1313

1414
namespace ApiPlatform\Doctrine\Odm\Filter;
1515

16+
use ApiPlatform\Doctrine\Common\Filter\ManagerRegistryAwareInterface;
1617
use ApiPlatform\Doctrine\Common\Filter\PropertyAwareFilterInterface;
1718
use ApiPlatform\Doctrine\Common\PropertyHelperTrait;
1819
use ApiPlatform\Doctrine\Odm\PropertyHelperTrait as MongoDbOdmPropertyHelperTrait;
20+
use ApiPlatform\Metadata\Exception\RuntimeException;
1921
use ApiPlatform\Metadata\Operation;
2022
use Doctrine\ODM\MongoDB\Aggregation\Builder;
2123
use Doctrine\Persistence\ManagerRegistry;
@@ -30,14 +32,18 @@
3032
*
3133
* @author Alan Poulain <[email protected]>
3234
*/
33-
abstract class AbstractFilter implements FilterInterface, PropertyAwareFilterInterface
35+
abstract class AbstractFilter implements FilterInterface, PropertyAwareFilterInterface, ManagerRegistryAwareInterface
3436
{
3537
use MongoDbOdmPropertyHelperTrait;
3638
use PropertyHelperTrait;
3739
protected LoggerInterface $logger;
3840

39-
public function __construct(protected ManagerRegistry $managerRegistry, ?LoggerInterface $logger = null, protected ?array $properties = null, protected ?NameConverterInterface $nameConverter = null)
40-
{
41+
public function __construct(
42+
protected ?ManagerRegistry $managerRegistry = null,
43+
?LoggerInterface $logger = null,
44+
protected ?array $properties = null,
45+
protected ?NameConverterInterface $nameConverter = null,
46+
) {
4147
$this->logger = $logger ?? new NullLogger();
4248
}
4349

@@ -56,18 +62,35 @@ public function apply(Builder $aggregationBuilder, string $resourceClass, ?Opera
5662
*/
5763
abstract protected function filterProperty(string $property, $value, Builder $aggregationBuilder, string $resourceClass, ?Operation $operation = null, array &$context = []): void;
5864

59-
protected function getManagerRegistry(): ManagerRegistry
65+
public function hasManagerRegistry(): bool
66+
{
67+
return $this->managerRegistry instanceof ManagerRegistry;
68+
}
69+
70+
public function getManagerRegistry(): ManagerRegistry
6071
{
72+
if (!$this->hasManagerRegistry()) {
73+
throw new RuntimeException('ManagerRegistry must be initialized before accessing it.');
74+
}
75+
6176
return $this->managerRegistry;
6277
}
6378

64-
protected function getProperties(): ?array
79+
public function setManagerRegistry(ManagerRegistry $managerRegistry): void
80+
{
81+
$this->managerRegistry = $managerRegistry;
82+
}
83+
84+
/**
85+
* @return array<string, mixed>|null
86+
*/
87+
public function getProperties(): ?array
6588
{
6689
return $this->properties;
6790
}
6891

6992
/**
70-
* @param string[] $properties
93+
* @param array<string, mixed> $properties
7194
*/
7295
public function setProperties(array $properties): void
7396
{

Diff for: ‎src/Doctrine/Odm/Filter/BooleanFilter.php

+11-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@
1414
namespace ApiPlatform\Doctrine\Odm\Filter;
1515

1616
use ApiPlatform\Doctrine\Common\Filter\BooleanFilterTrait;
17+
use ApiPlatform\Metadata\JsonSchemaFilterInterface;
1718
use ApiPlatform\Metadata\Operation;
19+
use ApiPlatform\Metadata\Parameter;
1820
use Doctrine\ODM\MongoDB\Aggregation\Builder;
1921
use Doctrine\ODM\MongoDB\Types\Type as MongoDbType;
2022

@@ -104,7 +106,7 @@
104106
* @author Teoh Han Hui <[email protected]>
105107
* @author Alan Poulain <[email protected]>
106108
*/
107-
final class BooleanFilter extends AbstractFilter
109+
final class BooleanFilter extends AbstractFilter implements JsonSchemaFilterInterface
108110
{
109111
use BooleanFilterTrait;
110112

@@ -139,4 +141,12 @@ protected function filterProperty(string $property, $value, Builder $aggregation
139141

140142
$aggregationBuilder->match()->field($matchField)->equals($value);
141143
}
144+
145+
/**
146+
* @return array<string, string>
147+
*/
148+
public function getSchema(Parameter $parameter): array
149+
{
150+
return ['type' => 'boolean'];
151+
}
142152
}

Diff for: ‎src/Doctrine/Odm/Filter/DateFilter.php

+27-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,12 @@
1616
use ApiPlatform\Doctrine\Common\Filter\DateFilterInterface;
1717
use ApiPlatform\Doctrine\Common\Filter\DateFilterTrait;
1818
use ApiPlatform\Metadata\Exception\InvalidArgumentException;
19+
use ApiPlatform\Metadata\JsonSchemaFilterInterface;
20+
use ApiPlatform\Metadata\OpenApiParameterFilterInterface;
1921
use ApiPlatform\Metadata\Operation;
22+
use ApiPlatform\Metadata\Parameter;
23+
use ApiPlatform\Metadata\QueryParameter;
24+
use ApiPlatform\OpenApi\Model\Parameter as OpenApiParameter;
2025
use Doctrine\ODM\MongoDB\Aggregation\Builder;
2126
use Doctrine\ODM\MongoDB\Types\Type as MongoDbType;
2227

@@ -117,7 +122,7 @@
117122
* @author Théo FIDRY <[email protected]>
118123
* @author Alan Poulain <[email protected]>
119124
*/
120-
final class DateFilter extends AbstractFilter implements DateFilterInterface
125+
final class DateFilter extends AbstractFilter implements DateFilterInterface, JsonSchemaFilterInterface, OpenApiParameterFilterInterface
121126
{
122127
use DateFilterTrait;
123128

@@ -237,4 +242,25 @@ private function addMatch(Builder $aggregationBuilder, string $field, string $op
237242

238243
$aggregationBuilder->match()->addAnd($aggregationBuilder->matchExpr()->field($field)->operator($operatorValue[$operator], $value));
239244
}
245+
246+
/**
247+
* @return array<string, string>
248+
*/
249+
public function getSchema(Parameter $parameter): array
250+
{
251+
return ['type' => 'date'];
252+
}
253+
254+
public function getOpenApiParameters(Parameter $parameter): OpenApiParameter|array|null
255+
{
256+
$in = $parameter instanceof QueryParameter ? 'query' : 'header';
257+
$key = $parameter->getKey();
258+
259+
return [
260+
new OpenApiParameter(name: $key.'[after]', in: $in),
261+
new OpenApiParameter(name: $key.'[before]', in: $in),
262+
new OpenApiParameter(name: $key.'[strictly_after]', in: $in),
263+
new OpenApiParameter(name: $key.'[strictly_before]', in: $in),
264+
];
265+
}
240266
}

Diff for: ‎src/Doctrine/Odm/Filter/ExistsFilter.php

+19-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@
1515

1616
use ApiPlatform\Doctrine\Common\Filter\ExistsFilterInterface;
1717
use ApiPlatform\Doctrine\Common\Filter\ExistsFilterTrait;
18+
use ApiPlatform\Metadata\JsonSchemaFilterInterface;
1819
use ApiPlatform\Metadata\Operation;
20+
use ApiPlatform\Metadata\Parameter;
1921
use Doctrine\ODM\MongoDB\Aggregation\Builder;
2022
use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
2123
use Doctrine\Persistence\ManagerRegistry;
@@ -107,12 +109,16 @@
107109
* @author Teoh Han Hui <[email protected]>
108110
* @author Alan Poulain <[email protected]>
109111
*/
110-
final class ExistsFilter extends AbstractFilter implements ExistsFilterInterface
112+
final class ExistsFilter extends AbstractFilter implements ExistsFilterInterface, JsonSchemaFilterInterface
111113
{
112114
use ExistsFilterTrait;
113115

114-
public function __construct(ManagerRegistry $managerRegistry, ?LoggerInterface $logger = null, ?array $properties = null, string $existsParameterName = self::QUERY_PARAMETER_KEY, ?NameConverterInterface $nameConverter = null)
116+
public function __construct(?ManagerRegistry $managerRegistry = null, ?LoggerInterface $logger = null, ?array $properties = null, string $existsParameterName = self::QUERY_PARAMETER_KEY, ?NameConverterInterface $nameConverter = null)
115117
{
118+
if (\is_array($properties) && \is_int(key($properties))) {
119+
$properties = array_flip($properties);
120+
}
121+
116122
parent::__construct($managerRegistry, $logger, $properties, $nameConverter);
117123

118124
$this->existsParameterName = $existsParameterName;
@@ -123,6 +129,12 @@ public function __construct(ManagerRegistry $managerRegistry, ?LoggerInterface $
123129
*/
124130
public function apply(Builder $aggregationBuilder, string $resourceClass, ?Operation $operation = null, array &$context = []): void
125131
{
132+
$parameter = $context['parameter'] ?? null;
133+
134+
if (null !== ($value = $context['filters'][$parameter?->getProperty()] ?? null)) {
135+
$this->filterProperty($this->denormalizePropertyName($parameter->getProperty()), $value, $aggregationBuilder, $resourceClass, $operation, $context);
136+
}
137+
126138
foreach ($context['filters'][$this->existsParameterName] ?? [] as $property => $value) {
127139
$this->filterProperty($this->denormalizePropertyName($property), $value, $aggregationBuilder, $resourceClass, $operation, $context);
128140
}
@@ -167,4 +179,9 @@ protected function isNullableField(string $property, string $resourceClass): boo
167179

168180
return $metadata instanceof ClassMetadata && $metadata->hasField($field) ? $metadata->isNullable($field) : false;
169181
}
182+
183+
public function getSchema(Parameter $parameter): array
184+
{
185+
return ['type' => 'boolean'];
186+
}
170187
}

Diff for: ‎src/Doctrine/Odm/Filter/NumericFilter.php

+8-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@
1414
namespace ApiPlatform\Doctrine\Odm\Filter;
1515

1616
use ApiPlatform\Doctrine\Common\Filter\NumericFilterTrait;
17+
use ApiPlatform\Metadata\JsonSchemaFilterInterface;
1718
use ApiPlatform\Metadata\Operation;
19+
use ApiPlatform\Metadata\Parameter;
1820
use Doctrine\ODM\MongoDB\Aggregation\Builder;
1921
use Doctrine\ODM\MongoDB\Types\Type as MongoDbType;
2022

@@ -104,7 +106,7 @@
104106
* @author Teoh Han Hui <[email protected]>
105107
* @author Alan Poulain <[email protected]>
106108
*/
107-
final class NumericFilter extends AbstractFilter
109+
final class NumericFilter extends AbstractFilter implements JsonSchemaFilterInterface
108110
{
109111
use NumericFilterTrait;
110112

@@ -163,4 +165,9 @@ protected function getType(?string $doctrineType = null): string
163165

164166
return 'int';
165167
}
168+
169+
public function getSchema(Parameter $parameter): array
170+
{
171+
return ['type' => 'numeric'];
172+
}
166173
}

Diff for: ‎src/Doctrine/Odm/Filter/RangeFilter.php

+18-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,11 @@
1515

1616
use ApiPlatform\Doctrine\Common\Filter\RangeFilterInterface;
1717
use ApiPlatform\Doctrine\Common\Filter\RangeFilterTrait;
18+
use ApiPlatform\Metadata\OpenApiParameterFilterInterface;
1819
use ApiPlatform\Metadata\Operation;
20+
use ApiPlatform\Metadata\Parameter;
21+
use ApiPlatform\Metadata\QueryParameter;
22+
use ApiPlatform\OpenApi\Model\Parameter as OpenApiParameter;
1923
use Doctrine\ODM\MongoDB\Aggregation\Builder;
2024

2125
/**
@@ -104,7 +108,7 @@
104108
* @author Lee Siong Chan <[email protected]>
105109
* @author Alan Poulain <[email protected]>
106110
*/
107-
final class RangeFilter extends AbstractFilter implements RangeFilterInterface
111+
final class RangeFilter extends AbstractFilter implements RangeFilterInterface, OpenApiParameterFilterInterface
108112
{
109113
use RangeFilterTrait;
110114

@@ -204,4 +208,17 @@ protected function addMatch(Builder $aggregationBuilder, string $field, string $
204208
break;
205209
}
206210
}
211+
212+
public function getOpenApiParameters(Parameter $parameter): OpenApiParameter|array|null
213+
{
214+
$in = $parameter instanceof QueryParameter ? 'query' : 'header';
215+
$key = $parameter->getKey();
216+
217+
return [
218+
new OpenApiParameter(name: $key.'[gt]', in: $in),
219+
new OpenApiParameter(name: $key.'[lt]', in: $in),
220+
new OpenApiParameter(name: $key.'[gte]', in: $in),
221+
new OpenApiParameter(name: $key.'[lte]', in: $in),
222+
];
223+
}
207224
}

Diff for: ‎src/Doctrine/Odm/PropertyHelperTrait.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
*/
2828
trait PropertyHelperTrait
2929
{
30-
abstract protected function getManagerRegistry(): ManagerRegistry;
30+
abstract protected function getManagerRegistry(): ?ManagerRegistry;
3131

3232
/**
3333
* Splits the given property into parts.
@@ -39,9 +39,9 @@ abstract protected function splitPropertyParts(string $property, string $resourc
3939
*/
4040
protected function getClassMetadata(string $resourceClass): ClassMetadata
4141
{
42-
$manager = $this
43-
->getManagerRegistry()
44-
->getManagerForClass($resourceClass);
42+
/** @var ?ManagerRegistry $managerRegistry */
43+
$managerRegistry = $this->getManagerRegistry();
44+
$manager = $managerRegistry?->getManagerForClass($resourceClass);
4545

4646
if ($manager) {
4747
return $manager->getClassMetadata($resourceClass);

0 commit comments

Comments
 (0)