feat(doctrine): new iri search filters

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: do something for nested properties?
+        $matchField = $parameter->getProperty();
+
+        $aggregationBuilder
+            ->match()
+            ->field($matchField)
+            ->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/Orm/Filter/ExactFilter.php

@@ -0,0 +1,61 @@
+<?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 ExactFilter 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
+            ->andWhere(\sprintf('%s.%s = :%s', $alias, $property, $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/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/GraphQl/Tests/Type/TypeConverterTest.php

@@ -30,14 +30,14 @@
 use GraphQL\Type\Definition\EnumType;
 use GraphQL\Type\Definition\ObjectType;
 use GraphQL\Type\Definition\Type as GraphQLType;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\IgnoreDeprecations;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
 use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Symfony\Component\PropertyInfo\Type as LegacyType;
 use Symfony\Component\TypeInfo\Type;
-use PHPUnit\Framework\Attributes\DataProvider;
-use PHPUnit\Framework\Attributes\IgnoreDeprecations;
 
 /**
  * @author Alan Poulain <[email protected]>

src/GraphQl/Type/FieldsBuilder.php

@@ -45,8 +45,8 @@
 use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
 use Symfony\Component\TypeInfo\Type;
 use Symfony\Component\TypeInfo\Type\CollectionType;
-use Symfony\Component\TypeInfo\TypeIdentifier;
 use Symfony\Component\TypeInfo\Type\ObjectType;
+use Symfony\Component\TypeInfo\TypeIdentifier;
 
 /**
  * Builds the GraphQL fields.

src/State/Provider/IriConverterParameterProvider.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\State\Provider;
+
+use ApiPlatform\Doctrine\Orm\Filter\IriFilter;
+use ApiPlatform\Metadata\IriConverterInterface;
+use ApiPlatform\Metadata\Operation;
+use ApiPlatform\Metadata\Parameter;
+use ApiPlatform\State\ParameterNotFound;
+use ApiPlatform\State\ParameterProviderInterface;
+
+/**
+ * @author Vincent Amstoutz
+ */
+final readonly class IriConverterParameterProvider implements ParameterProviderInterface
+{
+    public function __construct(
+        private IriConverterInterface $iriConverter,
+    ) {
+    }
+
+    public function provide(Parameter $parameter, array $parameters = [], array $context = []): ?Operation
+    {
+        $operation = $context['operation'] ?? null;
+        $parameterValue = $parameter->getValue();
+
+        $isParameterValueNotSet = !$parameterValue || $parameterValue instanceof ParameterNotFound;
+        if (!$parameter->getFilter() instanceof IriFilter || $isParameterValueNotSet) {
+            return $operation;
+        }
+
+        if (!\is_array($parameterValue)) {
+            $parameterValue = [$parameterValue];
+        }
+
+        $entities = [];
+        foreach ($parameterValue as $iri) {
+            $entities[] = $this->iriConverter->getResourceFromIri($iri, ['fetch_data' => false]);
+        }
+
+        $parameter->setValue($entities);
+
+        return $operation;
+    }
+}

src/Symfony/Bundle/Resources/config/state/provider.xml

@@ -42,5 +42,11 @@
             <argument type="service" id="api_platform.state_provider.parameter.inner" />
             <argument type="tagged_locator" tag="api_platform.parameter_provider" index-by="key" />
         </service>
+
+        <service id="api_platform.state_provider.parameter.iri_converter" class="ApiPlatform\State\Provider\IriConverterParameterProvider" public="false">
+            <argument type="service" id="api_platform.iri_converter"/>
+
+            <tag name="api_platform.parameter_provider" key="ApiPlatform\State\Provider\IriConverterParameterProvider" priority="-895" />
+        </service>
     </services>
 </container>

tests/Fixtures/TestBundle/Document/Chicken.php

@@ -0,0 +1,60 @@
+<?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\Tests\Fixtures\TestBundle\Document;
+
+use ApiPlatform\Metadata\Get;
+use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
+
+#[ODM\Document]
+#[Get]
+class Chicken
+{
+    #[ODM\Id]
+    private ?string $id = null;
+
+    #[ODM\Field(type: 'string')]
+    private string $name;
+
+    #[ODM\ReferenceOne(targetDocument: ChickenCoop::class, inversedBy: 'chickens')]
+    private ?ChickenCoop $chickenCoop = null;
+
+    public function getId(): ?string
+    {
+        return $this->id;
+    }
+
+    public function getName(): ?string
+    {
+        return $this->name;
+    }
+
+    public function setName(string $name): self
+    {
+        $this->name = $name;
+
+        return $this;
+    }
+
+    public function getChickenCoop(): ?ChickenCoop
+    {
+        return $this->chickenCoop;
+    }
+
+    public function setChickenCoop(?ChickenCoop $chickenCoop): self
+    {
+        $this->chickenCoop = $chickenCoop;
+
+        return $this;
+    }
+}