Add case sensitive option to PartialSearchFilter

Author: VincentLanglet

src/Doctrine/Odm/Filter/PartialSearchFilter.php

@@ -29,6 +29,10 @@ final class PartialSearchFilter implements FilterInterface, OpenApiParameterFilt
     use BackwardCompatibleFilterDescriptionTrait;
     use OpenApiFilterTrait;
 
+    public function __construct(private readonly bool $caseSensitive = true)
+    {
+    }
+
     public function apply(Builder $aggregationBuilder, string $resourceClass, ?Operation $operation = null, array &$context = []): void
     {
         $parameter = $context['parameter'];
@@ -47,7 +51,7 @@ public function apply(Builder $aggregationBuilder, string $resourceClass, ?Opera
         if (!is_iterable($values)) {
             $escapedValue = preg_quote($values, '/');
             $match->{$operator}(
-                $aggregationBuilder->matchExpr()->field($property)->equals(new Regex($escapedValue, 'i'))
+                $aggregationBuilder->matchExpr()->field($property)->equals(new Regex($escapedValue, $this->caseSensitive ? '' : 'i'))
             );
 
             return;
@@ -60,7 +64,7 @@ public function apply(Builder $aggregationBuilder, string $resourceClass, ?Opera
             $or->addOr(
                 $aggregationBuilder->matchExpr()
                     ->field($property)
-                    ->equals(new Regex($escapedValue, 'i'))
+                    ->equals(new Regex($escapedValue, $this->caseSensitive ? '' : 'i'))
             );
         }
 

src/Doctrine/Orm/Filter/PartialSearchFilter.php

@@ -29,6 +29,10 @@ final class PartialSearchFilter implements FilterInterface, OpenApiParameterFilt
     use BackwardCompatibleFilterDescriptionTrait;
     use OpenApiFilterTrait;
 
+    public function __construct(private readonly bool $caseSensitive = false)
+    {
+    }
+
     public function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, ?Operation $operation = null, array $context = []): void
     {
         $parameter = $context['parameter'];
@@ -46,7 +50,9 @@ public function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $q
             $parameterName = $queryNameGenerator->generateParameterName($property);
             $queryBuilder->setParameter($parameterName, $this->formatLikeValue($values));
 
-            $likeExpression = 'LOWER('.$field.') LIKE LOWER(:'.$parameterName.') ESCAPE \'\\\'';
+            $likeExpression = $this->caseSensitive
+                ? $field.' LIKE :'.$parameterName.' ESCAPE \'\\\''
+                : 'LOWER('.$field.') LIKE LOWER(:'.$parameterName.') ESCAPE \'\\\'';
             $queryBuilder->{$context['whereClause'] ?? 'andWhere'}($likeExpression);
 
             return;
@@ -55,7 +61,10 @@ public function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $q
         $likeExpressions = [];
         foreach ($values as $val) {
             $parameterName = $queryNameGenerator->generateParameterName($property);
-            $likeExpressions[] = 'LOWER('.$field.') LIKE LOWER(:'.$parameterName.') ESCAPE \'\\\'';
+            $likeExpressions[] = $this->caseSensitive
+                ? $field.' LIKE :'.$parameterName.' ESCAPE \'\\\''
+                : 'LOWER('.$field.') LIKE LOWER(:'.$parameterName.') ESCAPE \'\\\'';
+
             $queryBuilder->setParameter($parameterName, $this->formatLikeValue($val));
         }
 

tests/Fixtures/TestBundle/Document/Chicken.php

@@ -36,6 +36,10 @@
             property: 'name',
         ),
         'namePartialNoProperty' => new QueryParameter(filter: new PartialSearchFilter()),
+        'namePartialSensitive' => new QueryParameter(
+            filter: new PartialSearchFilter(true),
+            property: 'name',
+        ),
         'autocomplete' => new QueryParameter(filter: new FreeTextQueryFilter(new OrFilter(new ExactFilter())), properties: ['name', 'ean']),
         'q' => new QueryParameter(filter: new FreeTextQueryFilter(new PartialSearchFilter()), properties: ['name', 'ean']),
     ],

tests/Fixtures/TestBundle/Entity/Chicken.php

@@ -36,6 +36,10 @@
             property: 'name',
         ),
         'namePartialNoProperty' => new QueryParameter(filter: new PartialSearchFilter()),
+        'namePartialSensitive' => new QueryParameter(
+            filter: new PartialSearchFilter(true),
+            property: 'name',
+        ),
         'autocomplete' => new QueryParameter(filter: new FreeTextQueryFilter(new OrFilter(new ExactFilter())), properties: ['name', 'ean']),
         'q' => new QueryParameter(filter: new FreeTextQueryFilter(new PartialSearchFilter()), properties: ['name', 'ean']),
     ],

tests/Functional/Parameters/PartialSearchFilterTest.php

@@ -55,6 +55,7 @@ protected function setUp(): void
     }
 
     #[DataProvider('partialSearchFilterProvider')]
+    #[DataProvider('partialSearchFilterCaseSensitiveProvider')]
     public function testPartialSearchFilter(string $url, int $expectedCount, array $expectedNames): void
     {
         $response = self::createClient()->request('GET', $url);
@@ -193,6 +194,33 @@ public function testPartialSearchFilterThrowsExceptionWhenPropertyIsMissing(): v
         );
     }
 
+    public static function partialSearchFilterCaseSensitiveProvider(): \Generator
+    {
+        yield 'filter by partial name "tru"' => [
+            '/chickens?namePartial=tru',
+            1,
+            ['Gertrude'],
+        ];
+
+        yield 'filter by partial name "TRU"' => [
+            '/chickens?namePartial=TRU',
+            1,
+            ['Gertrude'],
+        ];
+
+        yield 'filter by case sensitive partial name "tru"' => [
+            '/chickens?namePartialSensitive=tru',
+            1,
+            ['Gertrude'],
+        ];
+
+        yield 'filter by case sensitive partial name "TRU"' => [
+            '/chickens?namePartialSensitive=TRU',
+            0,
+            [],
+        ];
+    }
+
     /**
      * @throws \Throwable
      * @throws MongoDBException