backup

api-platform · Mar 21, 2024 · bc42359 · bc42359
1 parent ed7a9e6
commit bc42359
Show file tree

Hide file tree

Showing 30 changed files with 111 additions and 87 deletions.
diff --git a/src/Doctrine/Orm/Extension/ParameterExtension.php b/src/Doctrine/Orm/Extension/ParameterExtension.php
@@ -14,7 +14,6 @@
 namespace ApiPlatform\Doctrine\Orm\Extension;
 
 use ApiPlatform\Doctrine\Orm\Filter\FilterInterface;
-use ApiPlatform\Doctrine\Orm\Filter\OrderFilter;
 use ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface;
 use ApiPlatform\Exception\InvalidArgumentException;
 use ApiPlatform\Metadata\HeaderParameterInterface;
@@ -31,7 +30,8 @@ public function __construct(private readonly ContainerInterface $filterLocator)
     {
     }
 
-    private function applyFilter(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, ?string $resourceClass = null, ?Operation $operation = null, array $context = []) {
+    private function applyFilter(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, ?string $resourceClass = null, ?Operation $operation = null, array $context = []): void
+    {
         if (!($request = $context['request'] ?? null)) {
             return;
         }
@@ -51,9 +51,10 @@ private function applyFilter(QueryBuilder $queryBuilder, QueryNameGeneratorInter
                 continue;
             }
 
+            $value = $parameters[$key];
             $filter = $this->filterLocator->has($filterId) ? $this->filterLocator->get($filterId) : null;
             if ($filter instanceof FilterInterface) {
-                $filter->apply($queryBuilder, $queryNameGenerator, $resourceClass, $operation, ['filters' => [$parameter->getProperty() ?? $key => $parameters[$key]]] + $context);
+                $filter->apply($queryBuilder, $queryNameGenerator, $resourceClass, $operation, ['filters' => [$key => $value]] + $context);
             }
         }
     }

diff --git a/src/Hydra/Serializer/CollectionFiltersNormalizer.php b/src/Hydra/Serializer/CollectionFiltersNormalizer.php
@@ -128,7 +128,7 @@ public function normalize(mixed $object, ?string $format = null, array $context
             }
         }
 
-        if ($currentFilters || $parameters) {
+        if ($currentFilters || ($parameters && \count($parameters))) {
             $data['hydra:search'] = $this->getSearch($resourceClass, $requestParts, $currentFilters, $parameters);
         }
 
@@ -151,7 +151,7 @@ public function setNormalizer(NormalizerInterface $normalizer): void
      * @param LegacyFilterInterface[]|FilterInterface[] $filters
      * @param array<string, Parameter>                  $parameters
      */
-    private function getSearch(string $resourceClass, array $parts, array $filters, null|array|Parameters $parameters): array
+    private function getSearch(string $resourceClass, array $parts, array $filters, array|Parameters|null $parameters): array
     {
         $variables = [];
         $mapping = [];
@@ -164,12 +164,26 @@ private function getSearch(string $resourceClass, array $parts, array $filters,
 
         foreach ($parameters ?? [] as $key => $parameter) {
             // Each IriTemplateMapping maps a variable used in the template to a property
-            if (!$parameter instanceof QueryParameterInterface || !($property = $parameter->getProperty())) {
+            if (!$parameter instanceof QueryParameterInterface) {
+                continue;
+            }
+
+            if (!($property = $parameter->getProperty()) && ($filterId = $parameter->getFilter())) {
+                $filter = $this->getFilter($filterId);
+                foreach ($filter->getDescription($resourceClass) as $variable => $description) {
+                    $variables[] = $variable;
+                    $m = ['@type' => 'IriTemplateMapping', 'variable' => $variable, 'property' => $description['property'], 'required' => $description['required']];
+                    if (null !== ($required = $parameter->getRequired())) {
+                        $m['required'] = $required;
+                    }
+                    $mapping[] = $m;
+                }
+
                 continue;
             }
 
-            $variables[] = $key;
             $m = ['@type' => 'IriTemplateMapping', 'variable' => $key, 'property' => $property];
+            $variables[] = $key;
             if (null !== ($required = $parameter->getRequired())) {
                 $m['required'] = $required;
             }

diff --git a/src/Metadata/ApiResource.php b/src/Metadata/ApiResource.php
@@ -960,7 +960,7 @@ public function __construct(
         $provider = null,
         $processor = null,
         protected ?OptionsInterface $stateOptions = null,
-        protected null|array|Parameters $parameters = null,
+        protected array|Parameters|null $parameters = null,
         protected array $extraProperties = [],
     ) {
         parent::__construct(

diff --git a/src/Metadata/Delete.php b/src/Metadata/Delete.php
@@ -94,7 +94,7 @@ public function __construct(
         $provider = null,
         $processor = null,
         ?OptionsInterface $stateOptions = null,
-        null|array|Parameters $parameters = null,
+        array|Parameters|null $parameters = null,
         array $extraProperties = [],
     ) {
         parent::__construct(

diff --git a/src/Metadata/Extractor/XmlResourceExtractor.php b/src/Metadata/Extractor/XmlResourceExtractor.php
@@ -535,7 +535,7 @@ private function buildParameters(\SimpleXMLElement $resource): ?array
                 property: $this->phpize($parameter, 'property', 'string'),
                 description: $this->phpize($parameter, 'description', 'string'),
                 priority: $this->phpize($parameter, 'priority', 'integer'),
-                extraProperties: $this->buildExtraProperties($parameter, 'extraProperties'),
+                extraProperties: $this->buildExtraProperties($parameter, 'extraProperties') ?? [],
             );
         }
 

diff --git a/src/Metadata/Extractor/YamlResourceExtractor.php b/src/Metadata/Extractor/YamlResourceExtractor.php
@@ -470,7 +470,7 @@ private function buildParameters(array $resource): ?array
                 key: $key,
                 required: $this->phpize($parameter, 'required', 'bool'),
                 schema: $parameter['schema'],
-                openapi: ($parameter['openapi'] ?? null) ? new Parameter(
+                openApi: ($parameter['openapi'] ?? null) ? new Parameter(
                     name: $parameter['openapi']['name'],
                     in: $parameter['in'] ?? 'query',
                     description: $parameter['openapi']['description'] ?? '',
@@ -490,7 +490,7 @@ private function buildParameters(array $resource): ?array
                 property: $this->phpize($parameter, 'property', 'string'),
                 description: $this->phpize($parameter, 'description', 'string'),
                 priority: $this->phpize($parameter, 'priority', 'integer'),
-                extraProperties: $this->buildArrayValue($resource, 'extraProperties'),
+                extraProperties: $this->buildArrayValue($parameter, 'extraProperties') ?? [],
             );
         }
 

diff --git a/src/Metadata/Get.php b/src/Metadata/Get.php
@@ -94,7 +94,7 @@ public function __construct(
         $provider = null,
         $processor = null,
         ?OptionsInterface $stateOptions = null,
-        null|array|Parameters $parameters = null,
+        array|Parameters|null $parameters = null,
         array $extraProperties = [],
     ) {
         parent::__construct(

diff --git a/src/Metadata/GetCollection.php b/src/Metadata/GetCollection.php
@@ -94,7 +94,7 @@ public function __construct(
         $provider = null,
         $processor = null,
         ?OptionsInterface $stateOptions = null,
-        null|array|Parameters $parameters = null,
+        array|Parameters|null $parameters = null,
         array $extraProperties = [],
         private ?string $itemUriTemplate = null,
     ) {

diff --git a/src/Metadata/GraphQl/Operation.php b/src/Metadata/GraphQl/Operation.php
@@ -85,7 +85,7 @@ public function __construct(
         $provider = null,
         $processor = null,
         ?OptionsInterface $stateOptions = null,
-        null|array|Parameters $parameters = null,
+        array|Parameters|null $parameters = null,
         array $extraProperties = []
     ) {
         parent::__construct(

diff --git a/src/Metadata/GraphQl/Query.php b/src/Metadata/GraphQl/Query.php
@@ -69,7 +69,7 @@ public function __construct(
         $provider = null,
         $processor = null,
         ?OptionsInterface $stateOptions = null,
-        null|array|Parameters $parameters = null,
+        array|Parameters|null $parameters = null,
         array $extraProperties = [],
 
         protected ?bool $nested = null,

diff --git a/src/Metadata/GraphQl/QueryCollection.php b/src/Metadata/GraphQl/QueryCollection.php
@@ -70,7 +70,7 @@ public function __construct(
         $provider = null,
         $processor = null,
         protected ?OptionsInterface $stateOptions = null,
-        null|array|Parameters $parameters = null,
+        array|Parameters|null $parameters = null,
         array $extraProperties = [],
 
         ?bool $nested = null,

diff --git a/src/Metadata/GraphQl/Subscription.php b/src/Metadata/GraphQl/Subscription.php
@@ -69,7 +69,7 @@ public function __construct(
         $provider = null,
         $processor = null,
         ?OptionsInterface $stateOptions = null,
-        null|array|Parameters $parameters = null,
+        array|Parameters|null $parameters = null,
         array $extraProperties = [],
     ) {
         parent::__construct(

diff --git a/src/Metadata/HttpOperation.php b/src/Metadata/HttpOperation.php
@@ -200,7 +200,7 @@ public function __construct(
         $provider = null,
         $processor = null,
         ?OptionsInterface $stateOptions = null,
-        null|array|Parameters $parameters = null,
+        array|Parameters|null $parameters = null,
         array $extraProperties = [],
     ) {
         parent::__construct(

diff --git a/src/Metadata/Metadata.php b/src/Metadata/Metadata.php
@@ -21,15 +21,15 @@
 abstract class Metadata
 {
     /**
-     * @param string|null              $deprecationReason       https://api-platform.com/docs/core/deprecations/#deprecating-resource-classes-operations-and-properties
-     * @param string|null              $security                https://api-platform.com/docs/core/security
-     * @param string|null              $securityPostDenormalize https://api-platform.com/docs/core/security/#executing-access-control-rules-after-denormalization
-     * @param mixed|null               $mercure
-     * @param mixed|null               $messenger
-     * @param mixed|null               $input
-     * @param mixed|null               $output
-     * @param mixed|null               $provider
-     * @param mixed|null               $processor
+     * @param string|null                         $deprecationReason       https://api-platform.com/docs/core/deprecations/#deprecating-resource-classes-operations-and-properties
+     * @param string|null                         $security                https://api-platform.com/docs/core/security
+     * @param string|null                         $securityPostDenormalize https://api-platform.com/docs/core/security/#executing-access-control-rules-after-denormalization
+     * @param mixed|null                          $mercure
+     * @param mixed|null                          $messenger
+     * @param mixed|null                          $input
+     * @param mixed|null                          $output
+     * @param mixed|null                          $provider
+     * @param mixed|null                          $processor
      * @param Parameters|array<string, Parameter> $parameters
      */
     public function __construct(
@@ -73,7 +73,7 @@ public function __construct(
         /**
          * @experimental
          */
-        protected null|array|Parameters $parameters = [],
+        protected array|Parameters|null $parameters = [],
         protected array $extraProperties = []
     ) {
     }
@@ -574,7 +574,7 @@ public function withStateOptions(?OptionsInterface $stateOptions): static
     /**
      * @return array<string, Parameter>
      */
-    public function getParameters(): null|array|Parameters
+    public function getParameters(): array|Parameters|null
     {
         return $this->parameters;
     }

diff --git a/src/Metadata/Operation.php b/src/Metadata/Operation.php
@@ -806,7 +806,7 @@ public function __construct(
         protected $provider = null,
         protected $processor = null,
         protected ?OptionsInterface $stateOptions = null,
-        protected null|array|Parameters $parameters = [],
+        protected array|Parameters|null $parameters = [],
         protected array $extraProperties = [],
     ) {
         parent::__construct(

diff --git a/src/Metadata/Parameter.php b/src/Metadata/Parameter.php
@@ -37,7 +37,7 @@ public function __construct(
         protected ?string $description = null,
         protected ?bool $required = null,
         protected ?int $priority = null,
-        protected array $extraProperties = [],
+        protected ?array $extraProperties = [],
     ) {
     }
 

diff --git a/src/Metadata/Parameters.php b/src/Metadata/Parameters.php
@@ -15,6 +15,8 @@
 
 /**
  * An parameter dictionnary.
+ *
+ * @implements \IteratorAggregate<string, Parameter>
  */
 final class Parameters implements \IteratorAggregate, \Countable
 {
@@ -36,6 +38,9 @@ public function __construct(array $parameters = [])
         $this->sort();
     }
 
+    /**
+     * @return \ArrayIterator<string, Parameter>
+     */
     public function getIterator(): \Traversable
     {
         return (function (): \Generator {

diff --git a/src/Metadata/Patch.php b/src/Metadata/Patch.php
@@ -94,7 +94,7 @@ public function __construct(
         $provider = null,
         $processor = null,
         ?OptionsInterface $stateOptions = null,
-        null|array|Parameters $parameters = null,
+        array|Parameters|null $parameters = null,
         array $extraProperties = [],
     ) {
         parent::__construct(

diff --git a/src/Metadata/Post.php b/src/Metadata/Post.php
@@ -94,7 +94,7 @@ public function __construct(
         $provider = null,
         $processor = null,
         ?OptionsInterface $stateOptions = null,
-        null|array|Parameters $parameters = null,
+        array|Parameters|null $parameters = null,
         array $extraProperties = [],
         private ?string $itemUriTemplate = null
     ) {

diff --git a/src/Metadata/Put.php b/src/Metadata/Put.php
@@ -94,7 +94,7 @@ public function __construct(
         $provider = null,
         $processor = null,
         ?OptionsInterface $stateOptions = null,
-        null|array|Parameters $parameters = null,
+        array|Parameters|null $parameters = null,
         array $extraProperties = [],
         private ?bool $allowCreate = null,
     ) {

diff --git a/src/Metadata/Resource/Factory/ParameterResourceMetadataCollectionFactory.php b/src/Metadata/Resource/Factory/ParameterResourceMetadataCollectionFactory.php
@@ -19,7 +19,6 @@
 use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
 use ApiPlatform\OpenApi;
 use ApiPlatform\Serializer\Filter\FilterInterface as SerializerFilterInterface;
-use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\WithParameter;
 use Psr\Container\ContainerInterface;
 
 /**
@@ -57,11 +56,11 @@ public function create(string $resourceClass): ResourceMetadataCollection
 
                     // Read filter description to populate the Parameter
                     $description = $filter instanceof FilterInterface ? $filter->getDescription($resourceClass) : [];
-                    if (($schema = $description['schema'] ?? null) && null === $parameter->getSchema()) {
+                    if (($schema = $description[$key]['schema'] ?? null) && null === $parameter->getSchema()) {
                         $parameter = $parameter->withSchema($schema);
                     }
 
-                    if (null === $parameter->getOpenApi() && $openApi = $description['openapi'] ?? null) {
+                    if (null === $parameter->getOpenApi() && $openApi = $description[$key]['openapi'] ?? null) {
                         if ($openApi instanceof OpenApi\Model\Parameter) {
                             $parameter = $parameter->withOpenApi($openApi);
                         }
@@ -70,8 +69,8 @@ public function create(string $resourceClass): ResourceMetadataCollection
                             $parameter->withOpenApi(new OpenApi\Model\Parameter(
                                 $key,
                                 $parameter instanceof HeaderParameterInterface ? 'header' : 'query',
-                                $description['description'] ?? '',
-                                $description['required'] ?? $openApi['required'] ?? false,
+                                $description[$key]['description'] ?? '',
+                                $description[$key]['required'] ?? $openApi['required'] ?? false,
                                 $openApi['deprecated'] ?? false,
                                 $openApi['allowEmptyValue'] ?? true,
                                 $schema,
@@ -97,25 +96,4 @@ public function create(string $resourceClass): ResourceMetadataCollection
 
         return $resourceMetadataCollection;
     }
-
-    /**
-     * @return Iterable<string, Parameter>
-     */
-    private function getIterator(null|array|\SplPriorityQueue $parameters): Iterable {
-        if (!$parameters) {
-            return [];
-        }
-
-        if (is_array($parameters)) {
-            foreach ($parameters as $key => $parameter) {
-                yield $key => $parameter;
-            }
-
-            return $parameters;
-        }
-
-        foreach ($parameters as $priority => $parameter) {
-            yield $parameter->getKey() => $parameter->withPriority($priority);
-        }
-    }
 }
diff --git a/src/Metadata/Tests/Extractor/XmlExtractorTest.php b/src/Metadata/Tests/Extractor/XmlExtractorTest.php
@@ -386,7 +386,7 @@ public function testValidXML(): void
                                     schema: [
                                         'type' => 'string',
                                     ],
-                                    extraProperties: []
+                                    extraProperties: ['foo' => 'bar']
                                 ),
                             ],
                         ],

diff --git a/src/Metadata/Tests/Extractor/YamlExtractorTest.php b/src/Metadata/Tests/Extractor/YamlExtractorTest.php
@@ -405,7 +405,7 @@ public function testValidYaml(): void
                             'stateOptions' => null,
                             'links' => null,
                             'headers' => ['hello' => 'world'],
-                            'parameters' => ['author' => new QueryParameter(schema: ['type' => 'string'], required: true, key: 'author')],
+                            'parameters' => ['author' => new QueryParameter(schema: ['type' => 'string'], required: true, key: 'author', description: 'hello')],
                         ],
                     ],
                     'graphQlOperations' => null,

diff --git a/src/OpenApi/Factory/OpenApiFactory.php b/src/OpenApi/Factory/OpenApiFactory.php
@@ -308,9 +308,9 @@ private function collectPaths(ApiResource $resource, ResourceMetadataCollection
             }
 
             $openapiParameters = $openapiOperation->getParameters();
-            foreach ($operation->getParameters() ?? [] as $p) {
+            foreach ($operation->getParameters() ?? [] as $key => $p) {
                 $in = $p instanceof HeaderParameterInterface ? 'header' : 'query';
-                $parameter = new Parameter($p->getKey(), $in, $p->getDescription() ?? "$resourceShortName $key", $p->getRequired() ?? false, false, false, $p->getSchema() ?? ['type' => 'string']);
+                $parameter = new Parameter($key, $in, $p->getDescription() ?? "$resourceShortName $key", $p->getRequired() ?? false, false, false, $p->getSchema() ?? ['type' => 'string']);
 
                 if ($linkParameter = $p->getOpenApi()) {
                     $parameter = $this->mergeParameter($parameter, $linkParameter);