fix(graphql): register query parameter arguments with filters (#6727)

api-platform · Oct 16, 2024 · 5503478 · 5503478
1 parent 99262dc
commit 5503478
Showing 1 changed file with 55 additions and 40 deletions.
diff --git a/src/GraphQl/Type/FieldsBuilder.php b/src/GraphQl/Type/FieldsBuilder.php
@@ -19,6 +19,7 @@
 use ApiPlatform\GraphQl\Resolver\Factory\ResolverFactory;
 use ApiPlatform\GraphQl\Resolver\Factory\ResolverFactoryInterface;
 use ApiPlatform\GraphQl\Type\Definition\TypeInterface;
+use ApiPlatform\Metadata\FilterInterface;
 use ApiPlatform\Metadata\GraphQl\Mutation;
 use ApiPlatform\Metadata\GraphQl\Operation;
 use ApiPlatform\Metadata\GraphQl\Query;
@@ -292,41 +293,6 @@ public function resolveResourceArgs(array $args, Operation $operation): array
             $args[$id]['type'] = $this->typeConverter->resolveType($arg['type']);
         }
 
-        /*
-         * This is @experimental, read the comment on the parameterToObjectType function as additional information.
-         */
-        foreach ($operation->getParameters() ?? [] as $parameter) {
-            $key = $parameter->getKey();
-
-            if (str_contains($key, ':property')) {
-                if (!($filterId = $parameter->getFilter()) || !$this->filterLocator->has($filterId)) {
-                    continue;
-                }
-
-                $parsedKey = explode('[:property]', $key);
-                $flattenFields = [];
-                foreach ($this->filterLocator->get($filterId)->getDescription($operation->getClass()) as $key => $value) {
-                    $values = [];
-                    parse_str($key, $values);
-                    if (isset($values[$parsedKey[0]])) {
-                        $values = $values[$parsedKey[0]];
-                    }
-
-                    $name = key($values);
-                    $flattenFields[] = ['name' => $name, 'required' => $value['required'] ?? null, 'description' => $value['description'] ?? null, 'leafs' => $values[$name], 'type' => $value['type'] ?? 'string'];
-                }
-
-                $args[$parsedKey[0]] = $this->parameterToObjectType($flattenFields, $parsedKey[0]);
-                continue;
-            }
-
-            $args[$key] = ['type' => GraphQLType::string()];
-
-            if ($parameter->getRequired()) {
-                $args[$key]['type'] = GraphQLType::nonNull($args[$key]['type']);
-            }
-        }
-
         return $args;
     }
 
@@ -448,12 +414,15 @@ private function getResourceFieldConfiguration(?string $property, ?string $field
 
             $args = [];
 
-            if (!$input && !$rootOperation instanceof Mutation && !$rootOperation instanceof Subscription && !$isStandardGraphqlType && $isCollectionType) {
-                if (!$this->isEnumClass($resourceClass) && $this->pagination->isGraphQlEnabled($resourceOperation)) {
-                    $args = $this->getGraphQlPaginationArgs($resourceOperation);
-                }
+            if (!$input && !$rootOperation instanceof Mutation && !$rootOperation instanceof Subscription && !$isStandardGraphqlType) {
+                if ($isCollectionType) {
+                    if (!$this->isEnumClass($resourceClass) && $this->pagination->isGraphQlEnabled($resourceOperation)) {
+                        $args = $this->getGraphQlPaginationArgs($resourceOperation);
+                    }
 
-                $args = $this->getFilterArgs($args, $resourceClass, $rootResource, $resourceOperation, $rootOperation, $property, $depth);
+                    $args = $this->getFilterArgs($args, $resourceClass, $rootResource, $resourceOperation, $rootOperation, $property, $depth);
+                    $args = $this->getParameterArgs($rootOperation, $args);
+                }
             }
 
             if ($this->itemResolverFactory instanceof ResolverFactory) {
@@ -488,6 +457,52 @@ private function getResourceFieldConfiguration(?string $property, ?string $field
         return null;
     }
 
+    /*
+     * This function is @experimental, read the comment on the parameterToObjectType function for additional information.
+     * @experimental
+     */
+    private function getParameterArgs(Operation $operation, array $args = []): array
+    {
+        foreach ($operation->getParameters() ?? [] as $parameter) {
+            $key = $parameter->getKey();
+
+            if (!str_contains($key, ':property')) {
+                $args[$key] = ['type' => GraphQLType::string()];
+
+                if ($parameter->getRequired()) {
+                    $args[$key]['type'] = GraphQLType::nonNull($args[$key]['type']);
+                }
+
+                continue;
+            }
+
+            if (!($filterId = $parameter->getFilter()) || !$this->filterLocator->has($filterId)) {
+                continue;
+            }
+
+            $filter = $this->filterLocator->get($filterId);
+            $parsedKey = explode('[:property]', $key);
+            $flattenFields = [];
+
+            if ($filter instanceof FilterInterface) {
+                foreach ($filter->getDescription($operation->getClass()) as $name => $value) {
+                    $values = [];
+                    parse_str($name, $values);
+                    if (isset($values[$parsedKey[0]])) {
+                        $values = $values[$parsedKey[0]];
+                    }
+
+                    $name = key($values);
+                    $flattenFields[] = ['name' => $name, 'required' => $value['required'] ?? null, 'description' => $value['description'] ?? null, 'leafs' => $values[$name], 'type' => $value['type'] ?? 'string'];
+                }
+
+                $args[$parsedKey[0]] = $this->parameterToObjectType($flattenFields, $parsedKey[0]);
+            }
+        }
+
+        return $args;
+    }
+
     private function getGraphQlPaginationArgs(Operation $queryOperation): array
     {
         $paginationType = $this->pagination->getGraphQlPaginationType($queryOperation);