Merge pull request #1715 from mykidok/fix-multiple-similar-apifilter

Allow to declare multiple filters with same class

Author: dunglas

features/doctrine/search_filter.feature

@@ -50,30 +50,30 @@ Feature: Search filter on collections
         },
 				"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:template": "\/dummy_cars{?availableAt[before],availableAt[strictly_before],availableAt[after],availableAt[strictly_after],canSell,foobar[],foobargroups[],foobargroups_override[],colors.prop,name}",
         "hydra:variableRepresentation": "BasicRepresentation",
         "hydra:mapping": [
           {
             "@type": "IriTemplateMapping",
-            "variable": "availableAt[before]",
+            "variable": "availableAt[after]",
             "property": "availableAt",
             "required": false
           },
           {
             "@type": "IriTemplateMapping",
-            "variable": "availableAt[strictly_before]",
+            "variable": "availableAt[before]",
             "property": "availableAt",
             "required": false
           },
           {
             "@type": "IriTemplateMapping",
-            "variable": "availableAt[after]",
+            "variable": "availableAt[strictly_after]",
             "property": "availableAt",
             "required": false
           },
           {
             "@type": "IriTemplateMapping",
-            "variable": "availableAt[strictly_after]",
+            "variable": "availableAt[strictly_before]",
             "property": "availableAt",
             "required": false
           },
@@ -83,6 +83,12 @@ Feature: Search filter on collections
             "property": "canSell",
             "required": false
           },
+          {
+            "@type": "IriTemplateMapping",
+            "variable": "colors.prop",
+            "property": "colors.prop",
+            "required": false
+          },
           {
             "@type": "IriTemplateMapping",
             "variable": "foobar[]",
@@ -97,8 +103,8 @@ Feature: Search filter on collections
           },
           {
             "@type": "IriTemplateMapping",
-            "variable": "colors.prop",
-            "property": "colors.prop",
+            "variable": "foobargroups_override[]",
+            "property": null,
             "required": false
           },
           {

src/Annotation/ApiFilter.php

@@ -26,6 +26,11 @@
  */
 final class ApiFilter
 {
+    /**
+     * @var string
+     */
+    public $id;
+
     /**
      * @var string
      */

src/Util/AnnotationFilterExtractorTrait.php

@@ -87,7 +87,7 @@ private function readFilterAnnotations(\ReflectionClass $reflectionClass, Reader
 
         foreach ($this->getFilterAnnotations($reader->getClassAnnotations($reflectionClass)) as $filterAnnotation) {
             $filterClass = $filterAnnotation->filterClass;
-            $id = $this->generateFilterId($reflectionClass, $filterClass);
+            $id = $this->generateFilterId($reflectionClass, $filterClass, $filterAnnotation->id);
 
             if (!isset($filters[$id])) {
                 $filters[$id] = [$filterAnnotation->arguments, $filterClass];
@@ -101,7 +101,7 @@ private function readFilterAnnotations(\ReflectionClass $reflectionClass, Reader
         foreach ($reflectionClass->getProperties() as $reflectionProperty) {
             foreach ($this->getFilterAnnotations($reader->getPropertyAnnotations($reflectionProperty)) as $filterAnnotation) {
                 $filterClass = $filterAnnotation->filterClass;
-                $id = $this->generateFilterId($reflectionClass, $filterClass);
+                $id = $this->generateFilterId($reflectionClass, $filterClass, $filterAnnotation->id);
 
                 if (!isset($filters[$id])) {
                     $filters[$id] = [$filterAnnotation->arguments, $filterClass];
@@ -131,11 +131,14 @@ private function readFilterAnnotations(\ReflectionClass $reflectionClass, Reader
      *
      * @param \ReflectionClass $reflectionClass the reflection class of a Resource
      * @param string           $filterClass     the filter class
+     * @param string           $filterId        the filter id
      *
      * @return string
      */
-    private function generateFilterId(\ReflectionClass $reflectionClass, string $filterClass): string
+    private function generateFilterId(\ReflectionClass $reflectionClass, string $filterClass, string $filterId = null): string
     {
-        return 'annotated_'.Inflector::tableize(str_replace('\\', '', $reflectionClass->getName().(new \ReflectionClass($filterClass))->getName()));
+        $suffix = null !== $filterId ? '_'.$filterId : $filterId;
+
+        return 'annotated_'.Inflector::tableize(str_replace('\\', '', $reflectionClass->getName().(new \ReflectionClass($filterClass))->getName().$suffix));
     }
 }

tests/Fixtures/TestBundle/Entity/DummyCar.php

@@ -35,6 +35,7 @@
  * @ApiFilter(BooleanFilter::class)
  * @ApiFilter(PropertyFilter::class, arguments={"parameterName": "foobar"})
  * @ApiFilter(GroupFilter::class, arguments={"parameterName": "foobargroups"})
+ * @ApiFilter(GroupFilter::class, arguments={"parameterName": "foobargroups_override"}, id="override")
  */
 class DummyCar
 {

tests/Util/AnnotationFilterExtractorTraitTest.php

@@ -62,6 +62,10 @@ public function testReadAnnotations()
             ['parameterName' => 'foobargroups'],
             GroupFilter::class,
           ],
+          'annotated_api_platform_core_tests_fixtures_test_bundle_entity_dummy_car_api_platform_core_serializer_filter_group_filter_override' => [
+            ['parameterName' => 'foobargroups_override'],
+            GroupFilter::class,
+          ],
         ]);
     }