udp

Author: soyuka

docs/guides/create-a-custom-doctrine-filter.php

@@ -13,15 +13,15 @@
 //
 // A Doctrine ORM filter has access to the `QueryBuilder` and the `QueryParameter` context.
 //
-// In this example, we create a `RegexpFilter` that applies a MySQL `REGEXP` condition. We map this filter to specific API parameters using the `#[QueryParameter]` attribute on our resource.
+// In this example, we create a `MinLengthFilter` that filters resources where the length of a property is greater than or equal to a specific value. We map this filter to specific API parameters using the `#[QueryParameter]` attribute on our resource.
 
 namespace App\Filter {
     use ApiPlatform\Doctrine\Orm\Filter\FilterInterface;
     use ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface;
     use ApiPlatform\Metadata\Operation;
     use Doctrine\ORM\QueryBuilder;
 
-    final class RegexpFilter implements FilterInterface
+    final class MinLengthFilter implements FilterInterface
     {
         //The `apply` method is where the filtering logic happens.
         //We retrieve the parameter definition and its value from the context.
@@ -47,7 +47,7 @@ public function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $q
             $alias = $queryBuilder->getRootAliases()[0];
 
             $queryBuilder
-                ->andWhere(sprintf('REGEXP(%s.%s, :%s) = 1', $alias, $property, $parameterName))
+                ->andWhere(sprintf('LENGTH(%s.%s) >= :%s', $alias, $property, $parameterName))
                 ->setParameter($parameterName, $value);
         }
 
@@ -64,17 +64,17 @@ public function getDescription(string $resourceClass): array
     use ApiPlatform\Metadata\ApiResource;
     use ApiPlatform\Metadata\GetCollection;
     use ApiPlatform\Metadata\QueryParameter;
-    use App\Filter\RegexpFilter;
+    use App\Filter\MinLengthFilter;
     use Doctrine\ORM\Mapping as ORM;
 
     #[ORM\Entity]
     #[ApiResource(
         operations: [
             new GetCollection(
                 parameters: [
-                    // We define a parameter 'regexp' that filters on the `title` and the `author` property using our custom logic.
-                    'regexp[:property]' => new QueryParameter(
-                        filter: RegexpFilter::class,
+                    // We define a parameter 'min_length' that filters on the `title` and the `author` property using our custom logic.
+                    'min_length[:property]' => new QueryParameter(
+                        filter: MinLengthFilter::class,
                         properties: ['title', 'author'],
                     ),
                 ]
@@ -101,7 +101,7 @@ class Book
 
     function request(): Request
     {
-        return Request::create('/books.jsonld?regexp[title]=^[Found]', 'GET');
+        return Request::create('/books.jsonld?min_length[title]=10', 'GET');
     }
 }
 
@@ -129,25 +129,25 @@ final class BookTest extends ApiTestCase
 
         public function testAsAnonymousICanAccessTheDocumentation(): void
         {
-            static::createClient()->request('GET', '/books.jsonld?regexp[title]=^[Found]');
+            static::createClient()->request('GET', '/books.jsonld?min_length[title]=10');
 
             $this->assertResponseIsSuccessful();
             $this->assertMatchesResourceCollectionJsonSchema(Book::class, '_api_/books{._format}_get_collection');
             $this->assertJsonContains([
                 'search' => [
                     '@type' => 'IriTemplate',
-                    'template' => '/books.jsonld{?regexp[title],regexp[author]}',
+                    'template' => '/books.jsonld{?min_length[title],min_length[author]}',
                     'variableRepresentation' => 'BasicRepresentation',
                     'mapping' => [
                         [
                             '@type' => 'IriTemplateMapping',
-                            'variable' => 'regexp[title]',
+                            'variable' => 'min_length[title]',
                             'property' => 'title',
                             'required' => false,
                         ],
                         [
                             '@type' => 'IriTemplateMapping',
-                            'variable' => 'regexp[author]',
+                            'variable' => 'min_length[author]',
                             'property' => 'author',
                             'required' => false,
                         ],