Implement Annotation filters @ApiFilter

features/bootstrap/FeatureContext.php

@@ -616,6 +616,9 @@ public function thereIsAFileConfigDummyObject()
     public function thereIsAFooEntityWithRelatedBars()
     {
         $foo = new DummyCar();
+        $foo->setName('mustli');
+        $foo->setCanSell(true);
+        $foo->setAvailableAt(new \DateTime());
         $this->manager->persist($foo);
 
         $bar1 = new DummyCarColor();

features/doctrine/search_filter.feature

@@ -48,19 +48,67 @@ Feature: Search filter on collections
             "@id": "/dummy_cars?colors.prop=red",
             "@type": "hydra:PartialCollectionView"
         },
-        "hydra:search": {
-            "@type": "hydra:IriTemplate",
-            "hydra:template": "/dummy_cars{?colors.prop}",
-            "hydra:variableRepresentation": "BasicRepresentation",
-            "hydra:mapping": [
-                {
-                    "@type": "IriTemplateMapping",
-                    "variable": "colors.prop",
-                    "property": "colors.prop",
-                    "required": false
-                }
-            ]
-        }
+				"hydra:search": {
+        "@type": "hydra:IriTemplate",
+        "hydra:template": "\/dummy_cars{?availableAt[before],availableAt[strictly_before],availableAt[after],availableAt[strictly_after],canSell,foobar[],foobargroups[],colors.prop,name}",
+        "hydra:variableRepresentation": "BasicRepresentation",
+        "hydra:mapping": [
+          {
+            "@type": "IriTemplateMapping",
+            "variable": "availableAt[before]",
+            "property": "availableAt",
+            "required": false
+          },
+          {
+            "@type": "IriTemplateMapping",
+            "variable": "availableAt[strictly_before]",
+            "property": "availableAt",
+            "required": false
+          },
+          {
+            "@type": "IriTemplateMapping",
+            "variable": "availableAt[after]",
+            "property": "availableAt",
+            "required": false
+          },
+          {
+            "@type": "IriTemplateMapping",
+            "variable": "availableAt[strictly_after]",
+            "property": "availableAt",
+            "required": false
+          },
+          {
+            "@type": "IriTemplateMapping",
+            "variable": "canSell",
+            "property": "canSell",
+            "required": false
+          },
+          {
+            "@type": "IriTemplateMapping",
+            "variable": "foobar[]",
+            "property": null,
+            "required": false
+          },
+          {
+            "@type": "IriTemplateMapping",
+            "variable": "foobargroups[]",
+            "property": null,
+            "required": false
+          },
+          {
+            "@type": "IriTemplateMapping",
+            "variable": "colors.prop",
+            "property": "colors.prop",
+            "required": false
+          },
+          {
+            "@type": "IriTemplateMapping",
+            "variable": "name",
+            "property": "name",
+            "required": false
+          }
+        ]
+      }
     }
     """
 

src/Annotation/ApiFilter.php

@@ -0,0 +1,70 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * 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\Core\Annotation;
+
+use ApiPlatform\Core\Api\FilterInterface;
+use ApiPlatform\Core\Exception\InvalidArgumentException;
+
+/**
+ * Filter annotation.
+ *
+ * @author Antoine Bluchet <soyuka@gmail.com>
+ *
+ * @Annotation
+ * @Target({"PROPERTY", "CLASS"})
+ */
+final class ApiFilter
+{
+    /**
+     * @var string
+     */
+    public $strategy;
+
+    /**
+     * @var string
+     */
+    public $filterClass;
+
+    /**
+     * @var array
+     */
+    public $properties = [];
+
+    /**
+     * @var array raw arguments for the filter
+     */
+    public $arguments = [];
+
+    public function __construct($options = [])
+    {
+        if (!isset($options['value'])) {
+            throw new InvalidArgumentException('This annotation needs a value representing the filter class.');
+        }
+
+        if (!is_subclass_of($options['value'], FilterInterface::class)) {
+            throw new InvalidArgumentException(sprintf('The filter class "%s" does not implement "%s".', $options['value'], FilterInterface::class));
+        }
+
+        $this->filterClass = $options['value'];
+        unset($options['value']);
+
+        foreach ($options as $key => $value) {
+            if (!property_exists($this, $key)) {
+                throw new InvalidArgumentException(sprintf('Property "%s" does not exist on the ApiFilter annotation.', $key));
+            }
+
+            $this->$key = $value;
+        }
+    }
+}

src/Bridge/Symfony/Bundle/ApiPlatformBundle.php

@@ -13,6 +13,7 @@
 
 namespace ApiPlatform\Core\Bridge\Symfony\Bundle;
 
+use ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection\Compiler\AnnotationFilterPass;
 use ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection\Compiler\DataProviderPass;
 use ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection\Compiler\DoctrineQueryExtensionPass;
 use ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection\Compiler\FilterPass;
@@ -34,6 +35,7 @@ public function build(ContainerBuilder $container)
         parent::build($container);
 
         $container->addCompilerPass(new DataProviderPass());
+        $container->addCompilerPass(new AnnotationFilterPass());
         $container->addCompilerPass(new FilterPass());
         $container->addCompilerPass(new DoctrineQueryExtensionPass());
     }

src/Bridge/Symfony/Bundle/DependencyInjection/Compiler/AnnotationFilterPass.php

@@ -0,0 +1,68 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * 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\Core\Bridge\Symfony\Bundle\DependencyInjection\Compiler;
+
+use ApiPlatform\Core\Util\AnnotationFilterExtractorTrait;
+use ApiPlatform\Core\Util\ReflectionClassRecursiveIterator;
+use Doctrine\Common\Annotations\Reader;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+
+/**
+ * Injects filters.
+ *
+ * @internal
+ *
+ * @author Antoine Bluchet <soyuka@gmail.com>
+ */
+final class AnnotationFilterPass implements CompilerPassInterface
+{
+    use AnnotationFilterExtractorTrait;
+
+    const TAG_FILTER_NAME = 'api_platform.filter';
+
+    /**
+     * {@inheritdoc}
+     */
+    public function process(ContainerBuilder $container)
+    {
+        $resourceClassDirectories = $container->getParameter('api_platform.resource_class_directories');
+        $reader = $container->get('annotation_reader');
+
+        foreach (ReflectionClassRecursiveIterator::getReflectionClassesFromDirectories($resourceClassDirectories) as $className => $reflectionClass) {
+            $this->createFilterDefinitions($reflectionClass, $reader, $container);
+        }
+    }
+
+    private function createFilterDefinitions(\ReflectionClass $reflectionClass, Reader $reader, ContainerBuilder $container)
+    {
+        foreach ($this->readFilterAnnotations($reflectionClass, $reader) as $id => list($arguments, $filterClass)) {
+            if ($container->hasDefinition($id)) {
+                continue;
+            }
+
+            $definition = new Definition();
+            $definition->setClass($filterClass);
+            $definition->addTag(self::TAG_FILTER_NAME);
+            $definition->setAutowired(true);
+
+            foreach ($arguments as $key => $value) {
+                $definition->setArgument("$$key", $value);
+            }
+
+            $container->setDefinition($id, $definition);
+        }
+    }
+}

src/Bridge/Symfony/Bundle/Resources/config/metadata/annotation.xml

@@ -16,6 +16,11 @@
             <argument type="service" id="api_platform.metadata.resource.metadata_factory.annotation.inner" />
         </service>
 
+        <service id="api_platform.metadata.resource.filter_metadata_factory.annotation" decorates="api_platform.metadata.resource.metadata_factory" decoration-priority="20" class="ApiPlatform\Core\Metadata\Resource\Factory\AnnotationResourceFilterMetadataFactory" public="false">
+            <argument type="service" id="annotation_reader" />
+            <argument type="service" id="api_platform.metadata.resource.filter_metadata_factory.annotation.inner" />
+        </service>
+
         <!--
         Not used, the PropertyInfo factory is preferred.
 

src/Metadata/Resource/Factory/AnnotationResourceFilterMetadataFactory.php

@@ -0,0 +1,103 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * 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\Core\Metadata\Resource\Factory;
+
+use ApiPlatform\Core\Annotation\ApiFilter;
+use ApiPlatform\Core\Exception\ResourceClassNotFoundException;
+use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
+use ApiPlatform\Core\Util\AnnotationFilterExtractorTrait;
+use Doctrine\Common\Annotations\Reader;
+
+/**
+ * Adds filters to the resource metadata {@see ApiFilter} annotation.
+ *
+ * @author Antoine Bluchet <soyuka@gmail.com>
+ */
+final class AnnotationResourceFilterMetadataFactory implements ResourceMetadataFactoryInterface
+{
+    use AnnotationFilterExtractorTrait;
+
+    private $reader;
+    private $decorated;
+
+    public function __construct(Reader $reader, ResourceMetadataFactoryInterface $decorated = null)
+    {
+        $this->reader = $reader;
+        $this->decorated = $decorated;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function create(string $resourceClass): ResourceMetadata
+    {
+        $parentResourceMetadata = null;
+        if ($this->decorated) {
+            try {
+                $parentResourceMetadata = $this->decorated->create($resourceClass);
+            } catch (ResourceClassNotFoundException $resourceNotFoundException) {
+                // Ignore not found exception from decorated factories
+            }
+        }
+
+        if (null === $parentResourceMetadata) {
+            return $this->handleNotFound($parentResourceMetadata, $resourceClass);
+        }
+
+        try {
+            $reflectionClass = new \ReflectionClass($resourceClass);
+        } catch (\ReflectionException $reflectionException) {
+            return $this->handleNotFound($parentResourceMetadata, $resourceClass);
+        }
+
+        $filters = array_keys($this->readFilterAnnotations($reflectionClass, $this->reader));
+
+        if (!$filters) {
+            return $parentResourceMetadata;
+        }
+
+        $parentFilters = $parentResourceMetadata->getAttribute('filters', []);
+
+        if ($parentFilters) {
+            $filters = array_merge($parentFilters, $filters);
+        }
+
+        $attributes = $parentResourceMetadata->getAttributes();
+
+        if (!$attributes) {
+            $attributes = [];
+        }
+
+        return $parentResourceMetadata->withAttributes(array_merge($attributes, ['filters' => $filters]));
+    }
+
+    /**
+     * Returns the metadata from the decorated factory if available or throws an exception.
+     *
+     * @param ResourceMetadata|null $parentPropertyMetadata
+     * @param string                $resourceClass
+     *
+     * @throws ResourceClassNotFoundException
+     *
+     * @return ResourceMetadata
+     */
+    private function handleNotFound(ResourceMetadata $parentPropertyMetadata = null, string $resourceClass): ResourceMetadata
+    {
+        if (null !== $parentPropertyMetadata) {
+            return $parentPropertyMetadata;
+        }
+
+        throw new ResourceClassNotFoundException(sprintf('Resource "%s" not found.', $resourceClass));
+    }
+}