Skip to content

fix: fix PartialSearchFilter and ExactFilter #7573

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: 4.2
Choose a base branch
from
+79 −36
Open

fix: fix PartialSearchFilter and ExactFilter #7573

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c69c666
fix: fix PartialSearchFilter
Coffee2CodeNL Dec 1, 2025
345ebd9
refactor: php-cs-fixer style changes
Coffee2CodeNL Dec 1, 2025
c5ddd70
fix: fix ExactFilter
Coffee2CodeNL Dec 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 18 additions & 12 deletions src/Doctrine/Orm/Filter/ExactFilter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,25 @@ final class ExactFilter implements FilterInterface, OpenApiParameterFilterInterf
public function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, ?Operation $operation = null, array $context = []): void
{
$parameter = $context['parameter'];
$value = $parameter->getValue();
$property = $parameter->getProperty();
$alias = $queryBuilder->getRootAliases()[0];
$parameterName = $queryNameGenerator->generateParameterName($property);

if (\is_array($value)) {
$queryBuilder
->{$context['whereClause'] ?? 'andWhere'}(\sprintf('%s.%s IN (:%s)', $alias, $property, $parameterName));
} else {
$queryBuilder
->{$context['whereClause'] ?? 'andWhere'}(\sprintf('%s.%s = :%s', $alias, $property, $parameterName));
$properties = $parameter->getProperties() ?? [$parameter->getProperty()];
foreach ($properties as $property) {
$parameterName = $queryNameGenerator->generateParameterName($property);
$values = $parameter->getValue();

if (is_iterable($values)) {
$queryBuilder
->{$context['whereClause'] ?? 'andWhere'}(
\sprintf('%s.%s IN (:%s)', $alias, $property, $parameterName)
);
} else {
$queryBuilder
->{$context['whereClause'] ?? 'andWhere'}(
\sprintf('%s.%s = :%s', $alias, $property, $parameterName)
);
}

$queryBuilder->setParameter($parameterName, $values);
}

$queryBuilder->setParameter($parameterName, $value);
}
}
49 changes: 26 additions & 23 deletions src/Doctrine/Orm/Filter/PartialSearchFilter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@

/**
* @author Vincent Amstoutz <[email protected]>
* @author Ré Schopmeijer <[email protected]>
*/
final class PartialSearchFilter implements FilterInterface, OpenApiParameterFilterInterface
{
Expand All @@ -31,35 +32,37 @@ final class PartialSearchFilter implements FilterInterface, OpenApiParameterFilt
public function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, ?Operation $operation = null, array $context = []): void
{
$parameter = $context['parameter'];
$property = $parameter->getProperty();
$alias = $queryBuilder->getRootAliases()[0];
$field = $alias.'.'.$property;
$parameterName = $queryNameGenerator->generateParameterName($property);
$values = $parameter->getValue();
$properties = $parameter->getProperties() ?? [$parameter->getProperty()];
foreach ($properties as $property) {
$field = $alias.'.'.$property;
$parameterName = $queryNameGenerator->generateParameterName($property);
$values = $parameter->getValue();

if (!is_iterable($values)) {
$queryBuilder->setParameter($parameterName, '%'.strtolower($values).'%');
if (!is_iterable($values)) {
$queryBuilder->setParameter($parameterName, '%'.strtolower($values).'%');

$queryBuilder->{$context['whereClause'] ?? 'andWhere'}($queryBuilder->expr()->like(
'LOWER('.$field.')',
':'.$parameterName
));
$queryBuilder->{$context['whereClause'] ?? 'andWhere'}($queryBuilder->expr()->like(
'LOWER('.$field.')',
':'.$parameterName,
));

return;
}
continue;
}

$likeExpressions = [];
foreach ($values as $val) {
$parameterName = $queryNameGenerator->generateParameterName($property);
$likeExpressions[] = $queryBuilder->expr()->like(
'LOWER('.$field.')',
':'.$parameterName
$likeExpressions = [];
foreach ($values as $val) {
$parameterName = $queryNameGenerator->generateParameterName($property);
$likeExpressions[] = $queryBuilder->expr()->like(
'LOWER('.$field.')',
':'.$parameterName,
);
$queryBuilder->setParameter($parameterName, '%'.strtolower($val).'%');
}

$queryBuilder->{$context['whereClause'] ?? 'andWhere'}(
$queryBuilder->expr()->orX(...$likeExpressions),
);
$queryBuilder->setParameter($parameterName, '%'.strtolower($val).'%');
}

$queryBuilder->{$context['whereClause'] ?? 'andWhere'}(
$queryBuilder->expr()->orX(...$likeExpressions)
);
}
}
10 changes: 10 additions & 0 deletions tests/Fixtures/TestBundle/Entity/SearchFilterParameter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

namespace ApiPlatform\Tests\Fixtures\TestBundle\Entity;

use ApiPlatform\Doctrine\Orm\Filter\ExactFilter;
use ApiPlatform\Doctrine\Orm\Filter\PartialSearchFilter;
use ApiPlatform\Metadata\ApiFilter;
use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\GetCollection;
Expand All @@ -34,6 +36,14 @@
'searchPartial[:property]' => new QueryParameter(filter: 'app_search_filter_partial'),
'searchExact[:property]' => new QueryParameter(filter: 'app_search_filter_with_exact'),
'searchOnTextAndDate[:property]' => new QueryParameter(filter: 'app_filter_date_and_search'),
'searchPartialProperties[:property]' => new QueryParameter(
filter : new PartialSearchFilter(),
properties: ['foo'],
),
'searchExactProperties[:property]' => new QueryParameter(
filter: new ExactFilter(),
properties: ['foo'],
),
'q' => new QueryParameter(property: 'hydra:freetextQuery'),
]
)]
Expand Down
26 changes: 25 additions & 1 deletion tests/Functional/Parameters/DoctrineTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ public function testDoctrineEntitySearchFilter(): void
$this->assertEquals('bar', $a['hydra:member'][1]['foo']);

$this->assertArraySubset(['hydra:search' => [
'hydra:template' => \sprintf('/%s{?foo,fooAlias,order[order[id]],order[order[foo]],searchPartial[foo],searchExact[foo],searchOnTextAndDate[foo],searchOnTextAndDate[createdAt][before],searchOnTextAndDate[createdAt][strictly_before],searchOnTextAndDate[createdAt][after],searchOnTextAndDate[createdAt][strictly_after],q,id,createdAt}', $route),
'hydra:template' => \sprintf('/%s{?foo,fooAlias,order[order[id]],order[order[foo]],searchPartial[foo],searchExact[foo],searchOnTextAndDate[foo],searchOnTextAndDate[createdAt][before],searchOnTextAndDate[createdAt][strictly_before],searchOnTextAndDate[createdAt][after],searchOnTextAndDate[createdAt][strictly_after],searchPartialProperties[foo],searchExactProperties[foo],q,id,createdAt}', $route),
]], $a);

$this->assertArraySubset(['@type' => 'IriTemplateMapping', 'variable' => 'fooAlias', 'property' => 'foo'], $a['hydra:search']['hydra:mapping'][1]);
Expand Down Expand Up @@ -118,6 +118,30 @@ public function testPropertyPlaceholderFilter(): void
$this->assertEquals($a['hydra:member'][0]['foo'], 'baz');
}

public function testPartialSearchFilterWithProperties(): void
{
static::bootKernel();
$resource = $this->isMongoDB() ? SearchFilterParameterDocument::class : SearchFilterParameter::class;
$this->recreateSchema([$resource]);
$this->loadFixtures($resource);
$route = 'search_filter_parameter';
$response = self::createClient()->request('GET', $route.'?searchPartialProperties[foo]=baz');
$a = $response->toArray();
$this->assertEquals($a['hydra:member'][0]['foo'], 'baz');
}

public function testExactFilterWithProperties(): void
{
static::bootKernel();
$resource = $this->isMongoDB() ? SearchFilterParameterDocument::class : SearchFilterParameter::class;
$this->recreateSchema([$resource]);
$this->loadFixtures($resource);
$route = 'search_filter_parameter';
$response = self::createClient()->request('GET', $route.'?searchExactProperties[foo]=baz');
$a = $response->toArray();
$this->assertEquals($a['hydra:member'][0]['foo'], 'baz');
}

public function testStateOptions(): void
{
if ($this->isMongoDB()) {
Expand Down
Loading