feat(doctrine): new iri search filters

src/Doctrine/Odm/Filter/ExactFilter.php

@@ -0,0 +1,52 @@
+<?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\Metadata\OpenApiParameterFilterInterface;
+use ApiPlatform\Metadata\Operation;
+use ApiPlatform\Metadata\Parameter;
+use ApiPlatform\OpenApi\Model\Parameter as OpenApiParameter;
+use Doctrine\ODM\MongoDB\Aggregation\Builder;
+
+final class ExactFilter implements FilterInterface, OpenApiParameterFilterInterface
+{
+    public function apply(Builder $aggregationBuilder, string $resourceClass, ?Operation $operation = null, array &$context = []): void
+    {
+        if (!$parameter = $context['parameter'] ?? null) {
+            return;
+        }
+
+        \assert($parameter instanceof Parameter);
+
+        $values = (array) $parameter->getValue();
+
+        //TODO: handle nested properties
+        $property = $parameter->getProperty();
+
+        $aggregationBuilder
+            ->match()
+            ->field($property)
+            ->in($values);
+    }
+
+    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/IriFilter.php

@@ -0,0 +1,62 @@
+<?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\Metadata\OpenApiParameterFilterInterface;
+use ApiPlatform\Metadata\Operation;
+use ApiPlatform\Metadata\Parameter;
+use ApiPlatform\Metadata\ParameterProviderFilterInterface;
+use ApiPlatform\OpenApi\Model\Parameter as OpenApiParameter;
+use ApiPlatform\State\Provider\IriConverterParameterProvider;
+use Doctrine\ODM\MongoDB\Aggregation\Builder;
+
+final class IriFilter implements FilterInterface, OpenApiParameterFilterInterface, ParameterProviderFilterInterface
+{
+    public function apply(Builder $aggregationBuilder, string $resourceClass, ?Operation $operation = null, array &$context = []): void
+    {
+        if (!$parameter = $context['parameter'] ?? null) {
+            return;
+        }
+
+        \assert($parameter instanceof Parameter);
+
+        $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;
+    }
+
+    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/PartialSearchFilter.php

@@ -0,0 +1,57 @@
+<?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\Metadata\OpenApiParameterFilterInterface;
+use ApiPlatform\Metadata\Operation;
+use ApiPlatform\Metadata\Parameter;
+use ApiPlatform\OpenApi\Model\Parameter as OpenApiParameter;
+use Doctrine\ODM\MongoDB\Aggregation\Builder;
+use MongoDB\BSON\Regex;
+
+final class PartialSearchFilter implements FilterInterface, OpenApiParameterFilterInterface
+{
+    public function apply(Builder $aggregationBuilder, string $resourceClass, ?Operation $operation = null, array &$context = []): void
+    {
+        if (!$parameter = $context['parameter'] ?? null) {
+            return;
+        }
+
+        \assert($parameter instanceof Parameter);
+
+        $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'));
+    }
+
+    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/Orm/Filter/ExactFilter.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\Orm\Filter;
+
+use ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface;
+use ApiPlatform\Metadata\OpenApiParameterFilterInterface;
+use ApiPlatform\Metadata\Operation;
+use ApiPlatform\Metadata\Parameter;
+use ApiPlatform\OpenApi\Model\Parameter as OpenApiParameter;
+use Doctrine\ORM\QueryBuilder;
+
+final class ExactFilter implements FilterInterface, OpenApiParameterFilterInterface
+{
+    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);
+    }
+
+    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/Orm/Filter/IriFilter.php

@@ -0,0 +1,62 @@
+<?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\Orm\Util\QueryNameGeneratorInterface;
+use ApiPlatform\Metadata\OpenApiParameterFilterInterface;
+use ApiPlatform\Metadata\Operation;
+use ApiPlatform\Metadata\Parameter;
+use ApiPlatform\Metadata\ParameterProviderFilterInterface;
+use ApiPlatform\OpenApi\Model\Parameter as OpenApiParameter;
+use ApiPlatform\State\Provider\IriConverterParameterProvider;
+use Doctrine\ORM\QueryBuilder;
+
+final class IriFilter implements FilterInterface, OpenApiParameterFilterInterface, ParameterProviderFilterInterface
+{
+    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;
+    }
+
+    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/Orm/Filter/PartialSearchFilter.php

@@ -0,0 +1,58 @@
+<?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\Orm\Util\QueryNameGeneratorInterface;
+use ApiPlatform\Metadata\OpenApiParameterFilterInterface;
+use ApiPlatform\Metadata\Operation;
+use ApiPlatform\Metadata\Parameter;
+use ApiPlatform\OpenApi\Model\Parameter as OpenApiParameter;
+use Doctrine\ORM\QueryBuilder;
+
+final class PartialSearchFilter implements FilterInterface, OpenApiParameterFilterInterface
+{
+    public function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, ?Operation $operation = null, array $context = []): void
+    {
+        if (!$parameter = $context['parameter'] ?? null) {
+            return;
+        }
+
+        $value = $parameter->getValue();
+
+        $property = $parameter->getProperty();
+        $alias = $queryBuilder->getRootAliases()[0];
+        $field = $alias.'.'.$property;
+
+        $parameterName = $queryNameGenerator->generateParameterName($property);
+
+        $likeExpression = $queryBuilder->expr()->like(
+            'LOWER('.$field.')',
+            ':'.$parameterName
+        );
+
+        $queryBuilder
+            ->andWhere($likeExpression)
+            ->setParameter($parameterName, '%'.strtolower($value).'%');
+    }
+
+    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 [];
+    }
+}