Skip to content

feat: not equal range filter #4746

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 5 commits into
base: main
Choose a base branch
from
Open

feat: not equal range filter #4746

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
68501b8
feat: add not equal range filter
divine May 5, 2022
808a68d
fix: behat test
divine May 5, 2022
c35b006
fix: more behat tests
divine May 5, 2022
f566882
feat: add not equal range filter test
divine May 5, 2022
063afd9
Merge branch 'api-platform:main' into not_equal
divine May 14, 2023
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
6 changes: 3 additions & 3 deletions features/doctrine/numeric_filter.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ Feature: Numeric filter on collections
"@type": {"pattern": "^IriTemplateMapping$"},
"variable": {
"oneOf": [
{"pattern": "^name_converted(\\[(between|gt|gte|lt|lte)?\\])?$"},
{"pattern": "^name_converted(\\[(between|gt|gte|lt|lte|ne)?\\])?$"},
{"pattern": "^order\\[name_converted\\]$"}
]
},
Expand All @@ -203,8 +203,8 @@ Feature: Numeric filter on collections
"required": ["@type", "variable", "property", "required"],
"additionalProperties": false
},
"minItems": 8,
"maxItems": 8,
"minItems": 9,
"maxItems": 9,
"uniqueItems": true
}
},
Expand Down
6 changes: 3 additions & 3 deletions features/doctrine/order_filter.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -964,7 +964,7 @@ Feature: Order filter on collections
"variable": {
"oneOf": [
{"pattern": "^order\\[name_converted\\]$"},
{"pattern": "^name_converted(\\[(between|gt|gte|lt|lte)?\\])?$"}
{"pattern": "^name_converted(\\[(between|gt|gte|lt|lte|ne)?\\])?$"}
]
},
"property": {"pattern": "^name_converted$"},
Expand All @@ -973,8 +973,8 @@ Feature: Order filter on collections
"required": ["@type", "variable", "property", "required"],
"additionalProperties": false
},
"minItems": 8,
"maxItems": 8,
"minItems": 9,
"maxItems": 9,
"uniqueItems": true
}
},
Expand Down
51 changes: 47 additions & 4 deletions features/doctrine/range_filter.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,6 +396,49 @@ Feature: Range filter on collections
}
"""

Scenario: Filter for entities by range (not equal to)
When I send a "GET" request to "/dummies?dummyPrice[ne]=12.99"
Then the response status code should be 200
And the response should be in JSON
And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
And the JSON should be valid according to this schema:
"""
{
"type": "object",
"properties": {
"@context": {"pattern": "^/contexts/Dummy$"},
"@id": {"pattern": "^/dummies$"},
"@type": {"pattern": "^hydra:Collection$"},
"hydra:member": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@id": {
"oneOf": [
{"pattern": "^/dummies/1$"},
{"pattern": "^/dummies/3$"},
{"pattern": "^/dummies/4$"}
]
}
}
},
"minItems": 3,
"maxItems": 3,
"uniqueItems": true
},
"hydra:totalItems": {"type": "number", "minimum": 22, "maximum": 22},
"hydra:view": {
"type": "object",
"properties": {
"@id": {"pattern": "^/dummies\\?dummyPrice%5Bne%5D=12.99"},
"@type": {"pattern": "^hydra:PartialCollectionView$"}
}
}
}
}
"""

Scenario: Filter for entities within an impossible range
When I send a "GET" request to "/dummies?dummyPrice[gt]=19.99"
Then the response status code should be 200
Expand Down Expand Up @@ -471,7 +514,7 @@ Feature: Range filter on collections
"type": "object",
"properties": {
"@type": {"pattern": "^hydra:IriTemplate$"},
"hydra:template": {"pattern": "^/converted_integers\\{\\?.*name_converted\\[between\\],name_converted\\[gt\\],name_converted\\[gte\\],name_converted\\[lt\\],name_converted\\[lte\\].*\\}$"},
"hydra:template": {"pattern": "^/converted_integers\\{\\?.*name_converted\\[between\\],name_converted\\[gt\\],name_converted\\[gte\\],name_converted\\[lt\\],name_converted\\[lte\\],name_converted\\[ne\\].*\\}$"},
"hydra:variableRepresentation": {"pattern": "^BasicRepresentation$"},
"hydra:mapping": {
"type": "array",
Expand All @@ -481,7 +524,7 @@ Feature: Range filter on collections
"@type": {"pattern": "^IriTemplateMapping$"},
"variable": {
"oneOf": [
{"pattern": "^name_converted(\\[(between|gt|gte|lt|lte)?\\])?$"},
{"pattern": "^name_converted(\\[(between|gt|gte|lt|lte|ne)?\\])?$"},
{"pattern": "^order\\[name_converted\\]$"}
]
},
Expand All @@ -491,8 +534,8 @@ Feature: Range filter on collections
"required": ["@type", "variable", "property", "required"],
"additionalProperties": false
},
"minItems": 8,
"maxItems": 8,
"minItems": 9,
"maxItems": 9,
"uniqueItems": true
}
},
Expand Down
14 changes: 13 additions & 1 deletion features/main/crud.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ Feature: Create-Retrieve-Update-Delete
"hydra:totalItems": 1,
"hydra:search": {
"@type": "hydra:IriTemplate",
"hydra:template": "/dummies{?dummyBoolean,relatedDummy.embeddedDummy.dummyBoolean,dummyDate[before],dummyDate[strictly_before],dummyDate[after],dummyDate[strictly_after],relatedDummy.dummyDate[before],relatedDummy.dummyDate[strictly_before],relatedDummy.dummyDate[after],relatedDummy.dummyDate[strictly_after],exists[alias],exists[description],exists[relatedDummy.name],exists[dummyBoolean],exists[relatedDummy],exists[relatedDummies],dummyFloat,dummyFloat[],dummyPrice,dummyPrice[],order[id],order[name],order[description],order[relatedDummy.name],order[relatedDummy.symfony],order[dummyDate],dummyFloat[between],dummyFloat[gt],dummyFloat[gte],dummyFloat[lt],dummyFloat[lte],dummyPrice[between],dummyPrice[gt],dummyPrice[gte],dummyPrice[lt],dummyPrice[lte],id,id[],name,alias,description,relatedDummy.name,relatedDummy.name[],relatedDummies,relatedDummies[],dummy,relatedDummies.name,relatedDummy.thirdLevel.level,relatedDummy.thirdLevel.level[],relatedDummy.thirdLevel.fourthLevel.level,relatedDummy.thirdLevel.fourthLevel.level[],relatedDummy.thirdLevel.badFourthLevel.level,relatedDummy.thirdLevel.badFourthLevel.level[],relatedDummy.thirdLevel.fourthLevel.badThirdLevel.level,relatedDummy.thirdLevel.fourthLevel.badThirdLevel.level[],name_converted,properties[]}",
"hydra:template": "/dummies{?dummyBoolean,relatedDummy.embeddedDummy.dummyBoolean,dummyDate[before],dummyDate[strictly_before],dummyDate[after],dummyDate[strictly_after],relatedDummy.dummyDate[before],relatedDummy.dummyDate[strictly_before],relatedDummy.dummyDate[after],relatedDummy.dummyDate[strictly_after],exists[alias],exists[description],exists[relatedDummy.name],exists[dummyBoolean],exists[relatedDummy],exists[relatedDummies],dummyFloat,dummyFloat[],dummyPrice,dummyPrice[],order[id],order[name],order[description],order[relatedDummy.name],order[relatedDummy.symfony],order[dummyDate],dummyFloat[between],dummyFloat[gt],dummyFloat[gte],dummyFloat[lt],dummyFloat[lte],dummyFloat[ne],dummyPrice[between],dummyPrice[gt],dummyPrice[gte],dummyPrice[lt],dummyPrice[lte],dummyPrice[ne],id,id[],name,alias,description,relatedDummy.name,relatedDummy.name[],relatedDummies,relatedDummies[],dummy,relatedDummies.name,relatedDummy.thirdLevel.level,relatedDummy.thirdLevel.level[],relatedDummy.thirdLevel.fourthLevel.level,relatedDummy.thirdLevel.fourthLevel.level[],relatedDummy.thirdLevel.badFourthLevel.level,relatedDummy.thirdLevel.badFourthLevel.level[],relatedDummy.thirdLevel.fourthLevel.badThirdLevel.level,relatedDummy.thirdLevel.fourthLevel.badThirdLevel.level[],name_converted,properties[]}",
"hydra:variableRepresentation": "BasicRepresentation",
"hydra:mapping": [
{
Expand Down Expand Up @@ -332,6 +332,12 @@ Feature: Create-Retrieve-Update-Delete
"property": "dummyFloat",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dummyFloat[ne]",
"property": "dummyFloat",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dummyPrice[between]",
Expand Down Expand Up @@ -362,6 +368,12 @@ Feature: Create-Retrieve-Update-Delete
"property": "dummyPrice",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "dummyPrice[ne]",
"property": "dummyPrice",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "id",
Expand Down
1 change: 1 addition & 0 deletions src/Doctrine/Common/Filter/RangeFilterInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,5 @@ interface RangeFilterInterface
public const PARAMETER_GREATER_THAN_OR_EQUAL = 'gte';
public const PARAMETER_LESS_THAN = 'lt';
public const PARAMETER_LESS_THAN_OR_EQUAL = 'lte';
public const PARAMETER_NOT_EQUAL = 'ne';
}
3 changes: 2 additions & 1 deletion src/Doctrine/Common/Filter/RangeFilterTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ public function getDescription(string $resourceClass): array
$description += $this->getFilterDescription($property, self::PARAMETER_GREATER_THAN_OR_EQUAL);
$description += $this->getFilterDescription($property, self::PARAMETER_LESS_THAN);
$description += $this->getFilterDescription($property, self::PARAMETER_LESS_THAN_OR_EQUAL);
$description += $this->getFilterDescription($property, self::PARAMETER_NOT_EQUAL);
}

return $description;
Expand Down Expand Up @@ -78,7 +79,7 @@ protected function getFilterDescription(string $fieldName, string $operator): ar

private function normalizeValues(array $values, string $property): ?array
{
$operators = [self::PARAMETER_BETWEEN, self::PARAMETER_GREATER_THAN, self::PARAMETER_GREATER_THAN_OR_EQUAL, self::PARAMETER_LESS_THAN, self::PARAMETER_LESS_THAN_OR_EQUAL];
$operators = [self::PARAMETER_BETWEEN, self::PARAMETER_GREATER_THAN, self::PARAMETER_GREATER_THAN_OR_EQUAL, self::PARAMETER_LESS_THAN, self::PARAMETER_LESS_THAN_OR_EQUAL, self::PARAMETER_NOT_EQUAL];

foreach ($values as $operator => $value) {
if (!\in_array($operator, $operators, true)) {
Expand Down
9 changes: 9 additions & 0 deletions src/Doctrine/Odm/Filter/RangeFilter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,15 @@ protected function addMatch(Builder $aggregationBuilder, string $field, string $

$aggregationBuilder->match()->field($matchField)->lte($value);

break;
case self::PARAMETER_NOT_EQUAL:
$value = $this->normalizeValue($value, $operator);
if (null === $value) {
return;
}

$aggregationBuilder->match()->field($matchField)->notEqual($value);

break;
}
}
Expand Down
11 changes: 11 additions & 0 deletions src/Doctrine/Orm/Filter/RangeFilter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,17 @@ protected function addWhere(QueryBuilder $queryBuilder, QueryNameGeneratorInterf
->andWhere(sprintf('%s.%s <= :%s', $alias, $field, $valueParameter))
->setParameter($valueParameter, $value);

break;
case self::PARAMETER_NOT_EQUAL:
$value = $this->normalizeValue($value, $operator);
if (null === $value) {
return;
}

$queryBuilder
->andWhere(sprintf('%s.%s <> :%s', $alias, $field, $valueParameter))
->setParameter($valueParameter, $value);

break;
}
}
Expand Down
16 changes: 16 additions & 0 deletions tests/Doctrine/Common/Filter/RangeFilterTestTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,22 @@ private function provideApplyTestArguments(): array
],
],
],
'ne' => [
null,
[
'dummyPrice' => [
'ne' => '9.99',
],
],
],
'ne (non-numeric)' => [
null,
[
'dummyPrice' => [
'ne' => '127.0.0.1',
],
],
],
];
}
}
Loading