feat: introduce Parameter::castToNativeType

Author: vincentchalamon

src/Metadata/Parameter.php

@@ -51,6 +51,7 @@ public function __construct(
         protected array|string|null $filterContext = null,
         protected ?Type $nativeType = null,
         protected ?bool $castToArray = null,
+        protected ?bool $castToNativeType = null,
     ) {
     }
 
@@ -332,4 +333,17 @@ public function withCastToArray(bool $castToArray): self
 
         return $self;
     }
+
+    public function getCastToNativeType(): ?bool
+    {
+        return $this->castToNativeType;
+    }
+
+    public function withCastToNativeType(bool $castToNativeType): self
+    {
+        $self = clone $this;
+        $self->castToNativeType = $castToNativeType;
+
+        return $self;
+    }
 }

src/State/Util/ParameterParserTrait.php

@@ -18,8 +18,10 @@
 use ApiPlatform\Metadata\Parameter;
 use ApiPlatform\State\ParameterNotFound;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\TypeInfo\Type;
 use Symfony\Component\TypeInfo\Type\CollectionType;
 use Symfony\Component\TypeInfo\Type\UnionType;
+use Symfony\Component\TypeInfo\TypeIdentifier;
 
 /**
  * @internal
@@ -45,7 +47,7 @@ private function getParameterValues(Parameter $parameter, ?Request $request, arr
      *
      * @return array<mixed, mixed>|ParameterNotFound|array
      */
-    private function extractParameterValues(Parameter $parameter, array $values): string|ParameterNotFound|array
+    private function extractParameterValues(Parameter $parameter, array $values): string|ParameterNotFound|array|bool
     {
         $accessors = null;
         $key = $parameter->getKey();
@@ -72,14 +74,26 @@ private function extractParameterValues(Parameter $parameter, array $values): st
                 $value = $value[$accessor];
             } else {
                 $value = new ParameterNotFound();
-                continue;
             }
         }
 
         if ($value instanceof ParameterNotFound) {
             return $value;
         }
 
+        // If "nativeType: new BuiltinType(TypeIdentifier::BOOL)"
+        // or "schema: ['type' => 'bool'], castToNativeType: true"
+        if ($parameter->getNativeType()?->isIdentifiedBy(TypeIdentifier::BOOL)
+            || (($parameter->getSchema()['type'] ?? null) === 'boolean' && $parameter->getCastToNativeType())
+        ) {
+            // Note: a HeaderParameter value might be sent as an array...
+            $value = match ($value) {
+                'true', 1, '1', [true], ['true'], [1], ['1'] => true,
+                'false', 0, '0', [false], ['false'], [0], ['0'] => false,
+                default => $value,
+            };
+        }
+
         $isCollectionType = fn ($t) => $t instanceof CollectionType;
         $isCollection = $parameter->getNativeType()?->isSatisfiedBy($isCollectionType) ?? false;
 

src/Validator/Metadata/Resource/Factory/ParameterValidationResourceMetadataCollectionFactory.php

@@ -28,7 +28,6 @@
 use Symfony\Component\Validator\Constraints\Collection;
 use Symfony\Component\Validator\Constraints\Count;
 use Symfony\Component\Validator\Constraints\DivisibleBy;
-use Symfony\Component\Validator\Constraints\Expression;
 use Symfony\Component\Validator\Constraints\GreaterThan;
 use Symfony\Component\Validator\Constraints\GreaterThanOrEqual;
 use Symfony\Component\Validator\Constraints\Length;
@@ -190,15 +189,10 @@ private function addSchemaValidation(Parameter $parameter, ?array $schema = null
             $assertions[] = new Unique();
         }
 
-        if (isset($schema['type']) && 'array' === $schema['type']) {
+        if (isset($schema['type']) && \in_array($schema['type'], ['array', 'boolean'], true)) {
             $assertions[] = new Type(type: $schema['type']);
         }
 
-        // Allow null in case of optional parameter
-        if (isset($schema['type']) && 'boolean' === $schema['type']) {
-            $assertions[] = new Expression(expression: 'value in [null, 0, 1, "0", "1", false, true, "false", "true"]');
-        }
-
         if (!$assertions) {
             return $parameter;
         }

tests/Fixtures/TestBundle/ApiResource/WithParameter.php

@@ -191,6 +191,7 @@
             schema: [
                 'type' => 'boolean',
             ],
+            castToNativeType: true,
         ),
     ],
     provider: [self::class, 'noopProvider']
@@ -231,6 +232,7 @@
             schema: [
                 'type' => 'boolean',
             ],
+            castToNativeType: true,
         ),
     ],
     provider: [self::class, 'noopProvider']