xml, yaml, priority parameters

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

Hide file tree

Showing 28 changed files with 423 additions and 59 deletions.
diff --git a/src/Doctrine/Orm/Extension/ParameterExtension.php b/src/Doctrine/Orm/Extension/ParameterExtension.php
@@ -0,0 +1,76 @@
+<?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\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;
+use ApiPlatform\Metadata\Operation;
+use Doctrine\ORM\QueryBuilder;
+use Psr\Container\ContainerInterface;
+
+/**
+ * @author Antoine Bluchet <soyuka@gmail.com>
+ */
+final class ParameterExtension implements QueryCollectionExtensionInterface, QueryItemExtensionInterface
+{
+    public function __construct(private readonly ContainerInterface $filterLocator)
+    {
+    }
+
+    private function applyFilter(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, ?string $resourceClass = null, ?Operation $operation = null, array $context = []) {
+        if (!($request = $context['request'] ?? null)) {
+            return;
+        }
+
+        if (null === $resourceClass) {
+            throw new InvalidArgumentException('The "$resourceClass" parameter must not be null');
+        }
+
+        foreach ($operation->getParameters() ?? [] as $parameter) {
+            $key = $parameter->getKey();
+            if (null === ($filterId = $parameter->getFilter())) {
+                continue;
+            }
+
+            $parameters = $parameter instanceof HeaderParameterInterface ? $request->attributes->get('_api_header_parameters') : $request->attributes->get('_api_query_parameters');
+            if (!isset($parameters[$key])) {
+                continue;
+            }
+
+            $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);
+            }
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, ?string $resourceClass = null, ?Operation $operation = null, array $context = []): void
+    {
+        $this->applyFilter($queryBuilder, $queryNameGenerator, $resourceClass, $operation, $context);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function applyToItem(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, array $identifiers, ?Operation $operation = null, array $context = []): void
+    {
+        $this->applyFilter($queryBuilder, $queryNameGenerator, $resourceClass, $operation, $context);
+    }
+}
diff --git a/src/Hydra/Serializer/CollectionFiltersNormalizer.php b/src/Hydra/Serializer/CollectionFiltersNormalizer.php
@@ -19,6 +19,7 @@
 use ApiPlatform\Doctrine\Orm\State\Options;
 use ApiPlatform\Metadata\FilterInterface;
 use ApiPlatform\Metadata\Parameter;
+use ApiPlatform\Metadata\Parameters;
 use ApiPlatform\Metadata\QueryParameterInterface;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use ApiPlatform\Metadata\ResourceClassResolverInterface;
@@ -150,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, ?array $parameters): array
+    private function getSearch(string $resourceClass, array $parts, array $filters, null|array|Parameters $parameters): array
     {
         $variables = [];
         $mapping = [];

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 ?array $parameters = null,
+        protected null|array|Parameters $parameters = null,
         protected array $extraProperties = [],
     ) {
         parent::__construct(

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

diff --git a/src/Metadata/Extractor/XmlResourceExtractor.php b/src/Metadata/Extractor/XmlResourceExtractor.php
@@ -515,6 +515,27 @@ private function buildParameters(\SimpleXMLElement $resource): ?array
                 key: $key,
                 required: $this->phpize($parameter, 'required', 'bool'),
                 schema: isset($parameter->schema->values) ? $this->buildValues($parameter->schema->values) : null,
+                openApi: isset($parameter->openapi) ? new OpenApiParameter(
+                    name: $this->phpize($parameter->openapi, 'name', 'string'),
+                    in: $this->phpize($parameter->openapi, 'in', 'string'),
+                    description: $this->phpize($parameter->openapi, 'description', 'string'),
+                    required: $this->phpize($parameter->openapi, 'required', 'bool'),
+                    deprecated: $this->phpize($parameter->openapi, 'deprecated', 'bool'),
+                    allowEmptyValue: $this->phpize($parameter->openapi, 'allowEmptyValue', 'bool'),
+                    schema: isset($parameter->openapi->schema->values) ? $this->buildValues($parameter->openapi->schema->values) : null,
+                    style: $this->phpize($parameter->openapi, 'style', 'string'),
+                    explode: $this->phpize($parameter->openapi, 'explode', 'bool'),
+                    allowReserved: $this->phpize($parameter->openapi, 'allowReserved', 'bool'),
+                    example: $this->phpize($parameter->openapi, 'example', 'string'),
+                    examples: isset($parameter->openapi->examples->values) ? new \ArrayObject($this->buildValues($parameter->openapi->examples->values)) : null,
+                    content: isset($parameter->openapi->content->values) ? new \ArrayObject($this->buildValues($parameter->openapi->content->values)) : null,
+                ) : null,
+                provider: $this->phpize($parameter, 'provider', 'string'),
+                filter: $this->phpize($parameter, 'filter', 'string'),
+                property: $this->phpize($parameter, 'property', 'string'),
+                description: $this->phpize($parameter, 'description', 'string'),
+                priority: $this->phpize($parameter, 'priority', 'integer'),
+                extraProperties: $this->buildExtraProperties($parameter, 'extraProperties'),
             );
         }
 

diff --git a/src/Metadata/Extractor/YamlResourceExtractor.php b/src/Metadata/Extractor/YamlResourceExtractor.php
@@ -469,7 +469,28 @@ private function buildParameters(array $resource): ?array
             $parameters[$key] = new $cl(
                 key: $key,
                 required: $this->phpize($parameter, 'required', 'bool'),
-                schema: $parameter['schema']
+                schema: $parameter['schema'],
+                openapi: ($parameter['openapi'] ?? null) ? new Parameter(
+                    name: $parameter['openapi']['name'],
+                    in: $parameter['in'] ?? 'query',
+                    description: $parameter['openapi']['description'] ?? '',
+                    required: $parameter['openapi']['required'] ?? $parameter['required'] ?? false,
+                    deprecated: $parameter['openapi']['deprecated'] ?? false,
+                    allowEmptyValue: $parameter['openapi']['allowEmptyValue'] ?? false,
+                    schema: $parameter['openapi']['schema'] ?? $parameter['schema'] ?? [],
+                    style: $parameter['openapi']['style'] ?? null,
+                    explode: $parameter['openapi']['explode'] ?? false,
+                    allowReserved: $parameter['openapi']['allowReserved '] ?? false,
+                    example: $parameter['openapi']['example'] ?? null,
+                    examples: isset($parameter['openapi']['examples']) ? new \ArrayObject($parameter['openapi']['examples']) : null,
+                    content: isset($parameter['openapi']['content']) ? new \ArrayObject($parameter['openapi']['content']) : null
+                ) : null,
+                provider: $this->phpize($parameter, 'provider', 'string'),
+                filter: $this->phpize($parameter, 'filter', 'string'),
+                property: $this->phpize($parameter, 'property', 'string'),
+                description: $this->phpize($parameter, 'description', 'string'),
+                priority: $this->phpize($parameter, 'priority', 'integer'),
+                extraProperties: $this->buildArrayValue($resource, '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,
-        ?array $parameters = null,
+        null|array|Parameters $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,
-        ?array $parameters = null,
+        null|array|Parameters $parameters = null,
         array $extraProperties = [],
         private ?string $itemUriTemplate = null,
     ) {

diff --git a/src/Metadata/GraphQl/Operation.php b/src/Metadata/GraphQl/Operation.php
@@ -15,6 +15,7 @@
 
 use ApiPlatform\Metadata\Link;
 use ApiPlatform\Metadata\Operation as AbstractOperation;
+use ApiPlatform\Metadata\Parameters;
 use ApiPlatform\State\OptionsInterface;
 
 class Operation extends AbstractOperation
@@ -84,7 +85,7 @@ public function __construct(
         $provider = null,
         $processor = null,
         ?OptionsInterface $stateOptions = null,
-        ?array $parameters = null,
+        null|array|Parameters $parameters = null,
         array $extraProperties = []
     ) {
         parent::__construct(

diff --git a/src/Metadata/GraphQl/Query.php b/src/Metadata/GraphQl/Query.php
@@ -13,6 +13,7 @@
 
 namespace ApiPlatform\Metadata\GraphQl;
 
+use ApiPlatform\Metadata\Parameters;
 use ApiPlatform\State\OptionsInterface;
 
 #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
@@ -68,7 +69,7 @@ public function __construct(
         $provider = null,
         $processor = null,
         ?OptionsInterface $stateOptions = null,
-        ?array $parameters = null,
+        null|array|Parameters $parameters = null,
         array $extraProperties = [],
 
         protected ?bool $nested = null,

diff --git a/src/Metadata/GraphQl/QueryCollection.php b/src/Metadata/GraphQl/QueryCollection.php
@@ -14,6 +14,7 @@
 namespace ApiPlatform\Metadata\GraphQl;
 
 use ApiPlatform\Metadata\CollectionOperationInterface;
+use ApiPlatform\Metadata\Parameters;
 use ApiPlatform\State\OptionsInterface;
 
 #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
@@ -69,7 +70,7 @@ public function __construct(
         $provider = null,
         $processor = null,
         protected ?OptionsInterface $stateOptions = null,
-        ?array $parameters = null,
+        null|array|Parameters $parameters = null,
         array $extraProperties = [],
 
         ?bool $nested = null,

diff --git a/src/Metadata/GraphQl/Subscription.php b/src/Metadata/GraphQl/Subscription.php
@@ -13,6 +13,7 @@
 
 namespace ApiPlatform\Metadata\GraphQl;
 
+use ApiPlatform\Metadata\Parameters;
 use ApiPlatform\State\OptionsInterface;
 
 #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
@@ -68,7 +69,7 @@ public function __construct(
         $provider = null,
         $processor = null,
         ?OptionsInterface $stateOptions = null,
-        ?array $parameters = null,
+        null|array|Parameters $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,
-        ?array $parameters = null,
+        null|array|Parameters $parameters = null,
         array $extraProperties = [],
     ) {
         parent::__construct(

diff --git a/src/Metadata/Metadata.php b/src/Metadata/Metadata.php
@@ -30,7 +30,7 @@ abstract class Metadata
      * @param mixed|null               $output
      * @param mixed|null               $provider
      * @param mixed|null               $processor
-     * @param array<string, Parameter> $parameters
+     * @param Parameters|array<string, Parameter> $parameters
      */
     public function __construct(
         protected ?string $shortName = null,
@@ -73,7 +73,7 @@ public function __construct(
         /**
          * @experimental
          */
-        protected ?array $parameters = [],
+        protected null|array|Parameters $parameters = [],
         protected array $extraProperties = []
     ) {
     }
@@ -574,12 +574,12 @@ public function withStateOptions(?OptionsInterface $stateOptions): static
     /**
      * @return array<string, Parameter>
      */
-    public function getParameters(): ?array
+    public function getParameters(): null|array|Parameters
     {
         return $this->parameters;
     }
 
-    public function withParameters(array $parameters): static
+    public function withParameters(array|Parameters $parameters): static
     {
         $self = clone $this;
         $self->parameters = $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 ?array $parameters = [],
+        protected null|array|Parameters $parameters = [],
         protected array $extraProperties = [],
     ) {
         parent::__construct(

diff --git a/src/Metadata/Parameter.php b/src/Metadata/Parameter.php
@@ -36,6 +36,7 @@ public function __construct(
         protected ?string $property = null,
         protected ?string $description = null,
         protected ?bool $required = null,
+        protected ?int $priority = null,
         protected array $extraProperties = [],
     ) {
     }
@@ -83,6 +84,11 @@ public function getRequired(): ?bool
         return $this->required;
     }
 
+    public function getPriority(): ?int
+    {
+        return $this->priority;
+    }
+
     /**
      * @return array<string, mixed>
      */
@@ -99,6 +105,14 @@ public function withKey(string $key): static
         return $self;
     }
 
+    public function withPriority(int $priority): static
+    {
+        $self = clone $this;
+        $self->priority = $priority;
+
+        return $self;
+    }
+
     /**
      * @param array{type?: string} $schema
      */