feat(doctrine): new iri search filters

src/Doctrine/Common/Filter/OpenApiFilterTrait.php

@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Doctrine\Common\Filter;
+
+use ApiPlatform\Metadata\Parameter;
+use ApiPlatform\OpenApi\Model\Parameter as OpenApiParameter;
+
+/**
+ * @author Vincent Amstoutz <[email protected]>
+ */
+trait OpenApiFilterTrait
+{
+    public function getOpenApiParameters(Parameter $parameter): OpenApiParameter|array|null
+    {
+        return new OpenApiParameter(name: $parameter->getKey().'[]', in: 'query', style: 'deepObject', explode: true);
+    }
+
+    public function getDescription(string $resourceClass): array
+    {
+        return [];
+    }
+}

src/Doctrine/Odm/Filter/ExactFilter.php

@@ -0,0 +1,44 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Doctrine\Odm\Filter;
+
+use ApiPlatform\Doctrine\Common\Filter\OpenApiFilterTrait;
+use ApiPlatform\Metadata\OpenApiParameterFilterInterface;
+use ApiPlatform\Metadata\Operation;
+use Doctrine\ODM\MongoDB\Aggregation\Builder;
+
+/**
+ * @author Vincent Amstoutz <[email protected]>
+ */
+final class ExactFilter implements FilterInterface, OpenApiParameterFilterInterface
+{
+    use OpenApiFilterTrait;
+
+    public function apply(Builder $aggregationBuilder, string $resourceClass, ?Operation $operation = null, array &$context = []): void
+    {
+        if (!$parameter = $context['parameter'] ?? null) {
+            return;
+        }
+
+        $values = (array) $parameter->getValue();
+
+        // TODO: handle nested properties
+        $property = $parameter->getProperty();
+
+        $aggregationBuilder
+            ->match()
+            ->field($property)
+            ->in($values);
+    }
+}

src/Doctrine/Odm/Filter/FilterInterface.php

@@ -15,6 +15,7 @@
 
 use ApiPlatform\Metadata\FilterInterface as BaseFilterInterface;
 use ApiPlatform\Metadata\Operation;
+use ApiPlatform\Metadata\Parameter;
 use Doctrine\ODM\MongoDB\Aggregation\Builder;
 
 /**
@@ -26,6 +27,8 @@ interface FilterInterface extends BaseFilterInterface
 {
     /**
      * Applies the filter.
+     *
+     * @param array|array{filters?: array<string, mixed>|array, parameter?: Parameter, mongodb_odm_sort_fields?: array, ...} $context
      */
     public function apply(Builder $aggregationBuilder, string $resourceClass, ?Operation $operation = null, array &$context = []): void;
 }

src/Doctrine/Odm/Filter/IriFilter.php

@@ -0,0 +1,54 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Doctrine\Odm\Filter;
+
+use ApiPlatform\Doctrine\Common\Filter\OpenApiFilterTrait;
+use ApiPlatform\Metadata\OpenApiParameterFilterInterface;
+use ApiPlatform\Metadata\Operation;
+use ApiPlatform\Metadata\ParameterProviderFilterInterface;
+use ApiPlatform\State\ParameterProvider\IriConverterParameterProvider;
+use Doctrine\ODM\MongoDB\Aggregation\Builder;
+
+/**
+ * @author Vincent Amstoutz <[email protected]>
+ */
+final class IriFilter implements FilterInterface, OpenApiParameterFilterInterface, ParameterProviderFilterInterface
+{
+    use OpenApiFilterTrait;
+
+    public function apply(Builder $aggregationBuilder, string $resourceClass, ?Operation $operation = null, array &$context = []): void
+    {
+        if (!$parameter = $context['parameter'] ?? null) {
+            return;
+        }
+
+        $value = $parameter->getValue();
+        if (!\is_array($value)) {
+            $value = [$value];
+        }
+
+        // TODO: handle nested properties
+        $property = $parameter->getProperty();
+
+        $aggregationBuilder
+            ->match()
+            ->field($property)
+            ->in($value);
+    }
+
+    public static function getParameterProvider(): string
+    {
+        return IriConverterParameterProvider::class;
+    }
+}

src/Doctrine/Odm/Filter/OrFilter.php

@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Doctrine\Odm\Filter;
+
+use ApiPlatform\Doctrine\Common\Filter\OpenApiFilterTrait;
+use ApiPlatform\Metadata\OpenApiParameterFilterInterface;
+use ApiPlatform\Metadata\Operation;
+use Doctrine\ODM\MongoDB\Aggregation\Builder;
+
+/**
+ * @author Vincent Amstoutz <[email protected]>
+ */
+final class OrFilter implements FilterInterface, OpenApiParameterFilterInterface
+{
+    use OpenApiFilterTrait;
+    /**
+     * @var array<FilterInterface>
+     */
+    private readonly array $filters;
+
+    public function __construct(FilterInterface ...$filters)
+    {
+        $this->filters = $filters;
+    }
+
+    public function apply(Builder $aggregationBuilder, string $resourceClass, ?Operation $operation = null, array &$context = []): void
+    {
+        foreach ($this->filters as $filter) {
+            $filter->apply($aggregationBuilder, $resourceClass, $operation, $context);
+        }
+    }
+}

src/Doctrine/Odm/Filter/PartialSearchFilter.php

@@ -0,0 +1,49 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Doctrine\Odm\Filter;
+
+use ApiPlatform\Doctrine\Common\Filter\OpenApiFilterTrait;
+use ApiPlatform\Metadata\OpenApiParameterFilterInterface;
+use ApiPlatform\Metadata\Operation;
+use Doctrine\ODM\MongoDB\Aggregation\Builder;
+use MongoDB\BSON\Regex;
+
+/**
+ * @author Vincent Amstoutz <[email protected]>
+ */
+final class PartialSearchFilter implements FilterInterface, OpenApiParameterFilterInterface
+{
+    use OpenApiFilterTrait;
+
+    public function apply(Builder $aggregationBuilder, string $resourceClass, ?Operation $operation = null, array &$context = []): void
+    {
+        if (!$parameter = $context['parameter'] ?? null) {
+            return;
+        }
+
+        $value = $parameter->getValue();
+        if (!\is_string($value) || '' === $value) {
+            return;
+        }
+
+        // TODO: handle nested properties
+        $property = $parameter->getProperty();
+        $escapedValue = preg_quote($value, '/');
+
+        $aggregationBuilder
+            ->match()
+            ->field($property)
+            ->equals(new Regex($escapedValue, 'i'));
+    }
+}

src/Doctrine/Orm/Filter/ExactFilter.php

@@ -0,0 +1,48 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Doctrine\Orm\Filter;
+
+use ApiPlatform\Doctrine\Common\Filter\OpenApiFilterTrait;
+use ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface;
+use ApiPlatform\Metadata\OpenApiParameterFilterInterface;
+use ApiPlatform\Metadata\Operation;
+use Doctrine\ORM\QueryBuilder;
+
+/**
+ * @author Vincent Amstoutz <[email protected]>
+ */
+final class ExactFilter implements FilterInterface, OpenApiParameterFilterInterface
+{
+    use OpenApiFilterTrait;
+
+    public function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, ?Operation $operation = null, array $context = []): void
+    {
+        if (!$parameter = $context['parameter'] ?? null) {
+            return;
+        }
+
+        $value = $parameter->getValue();
+        if (!\is_array($value)) {
+            $value = [$value];
+        }
+
+        $property = $parameter->getProperty();
+        $alias = $queryBuilder->getRootAliases()[0];
+        $parameterName = $queryNameGenerator->generateParameterName($property);
+
+        $queryBuilder
+            ->andWhere(\sprintf('%s.%s = :%s', $alias, $property, $parameterName))
+            ->setParameter($parameterName, $value);
+    }
+}

src/Doctrine/Orm/Filter/ExistsFilter.php

@@ -142,8 +142,11 @@ public function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $q
             return;
         }
 
-        foreach ($context['filters'][$this->existsParameterName] ?? [] as $property => $value) {
-            $this->filterProperty($this->denormalizePropertyName($property), $value, $queryBuilder, $queryNameGenerator, $resourceClass, $operation, $context);
+        $properties = $context['filters'][$this->existsParameterName];
+        if ([] !== $properties) {
+            foreach ($properties as $property => $value) {
+                $this->filterProperty($this->denormalizePropertyName($property), $value, $queryBuilder, $queryNameGenerator, $resourceClass, $operation, $context);
+            }
         }
     }
 

src/Doctrine/Orm/Filter/FilterInterface.php

@@ -16,6 +16,7 @@
 use ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface;
 use ApiPlatform\Metadata\FilterInterface as BaseFilterInterface;
 use ApiPlatform\Metadata\Operation;
+use ApiPlatform\Metadata\Parameter;
 use Doctrine\ORM\QueryBuilder;
 
 /**
@@ -27,6 +28,8 @@ interface FilterInterface extends BaseFilterInterface
 {
     /**
      * Applies the filter.
+     *
+     * @param array{filters?: array<string, mixed>|array, parameter?: Parameter, ...} $context
      */
     public function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, ?Operation $operation = null, array $context = []): void;
 }

src/Doctrine/Orm/Filter/IriFilter.php

@@ -0,0 +1,56 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Doctrine\Orm\Filter;
+
+use ApiPlatform\Doctrine\Common\Filter\OpenApiFilterTrait;
+use ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface;
+use ApiPlatform\Metadata\OpenApiParameterFilterInterface;
+use ApiPlatform\Metadata\Operation;
+use ApiPlatform\Metadata\ParameterProviderFilterInterface;
+use ApiPlatform\State\ParameterProvider\IriConverterParameterProvider;
+use Doctrine\ORM\QueryBuilder;
+
+/**
+ * @author Vincent Amstoutz <[email protected]>
+ */
+final class IriFilter implements FilterInterface, OpenApiParameterFilterInterface, ParameterProviderFilterInterface
+{
+    use OpenApiFilterTrait;
+
+    public function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, ?Operation $operation = null, array $context = []): void
+    {
+        if (!$parameter = $context['parameter'] ?? null) {
+            return;
+        }
+
+        $value = $parameter->getValue();
+        if (!\is_array($value)) {
+            $value = [$value];
+        }
+
+        $property = $parameter->getProperty();
+        $alias = $queryBuilder->getRootAliases()[0];
+        $parameterName = $queryNameGenerator->generateParameterName($property);
+
+        $queryBuilder
+            ->join(\sprintf('%s.%s', $alias, $property), $parameterName)
+            ->andWhere(\sprintf('%s IN(:%s)', $parameterName, $parameterName))
+            ->setParameter($parameterName, $value);
+    }
+
+    public static function getParameterProvider(): string
+    {
+        return IriConverterParameterProvider::class;
+    }
+}