Set a property as an id to use objects as types

uderline · May 31, 2022 · 702e951 · 702e951
1 parent 1fdcfb1
commit 702e951
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 3 deletions.
diff --git a/src/Attributes/IDParam.php b/src/Attributes/IDParam.php
@@ -24,6 +24,29 @@ public function __construct(
 
     public function setParamType(string $paramType): void
     {
+        // With frameworks' auto wiring, objects are injected as arguments.
+        // If the object has a Property(Type::STRING, isObjectId: true), use the type of the
+        // property (string for this example)
+        if (class_exists($paramType)) {
+            $reflection = new \ReflectionClass($paramType);
+            $attributes = $reflection->getAttributes();
+            $paramType = array_reduce(
+                $attributes,
+                function (?string $previous, \ReflectionAttribute $attribute) {
+                    if ($previous) {
+                        return $previous;
+                    }
+
+                    $instance = $attribute->newInstance();
+                    if ($instance instanceof Property && $instance->isObjectId()) {
+                        return $instance->getType();
+                    }
+
+                    return null;
+                }
+            );
+        }
+
         $this->schema = match ($paramType) {
             'int' => ['type' => 'integer', 'minimum' => 1],
             'bool' => ['type' => 'boolean'],

diff --git a/src/Attributes/Property.php b/src/Attributes/Property.php
@@ -25,7 +25,8 @@ public function __construct(
         private mixed $example = null,
         private ?string $format = null,
         private ?array $enum = null,
-        private ?string $ref = null
+        private ?string $ref = null,
+        private bool $isObjectId = false,
     ) {
         if ($this->ref) {
             $ref = explode('\\', $this->ref);
@@ -49,6 +50,11 @@ public function getProperty(): ?string
         return $this->property;
     }
 
+    public function isObjectId(): bool
+    {
+        return $this->isObjectId;
+    }
+
     public function jsonSerialize(): array
     {
         $type = $this->type;

diff --git a/tests/Examples/Dummy/DummyController.php b/tests/Examples/Dummy/DummyController.php
@@ -80,7 +80,7 @@ public function post(): void
         PUT("/path/{id}", ["Dummy"], "Dummy put"),
         Response(204)
     ]
-    public function put(#[IDParam] int $id, DummyRequest $dummyRequest): void
+    public function put(#[IDParam] DummyRefComponent $id, DummyRequest $dummyRequest): void
     {
         //
     }

diff --git a/tests/Examples/Dummy/DummyRefComponent.php b/tests/Examples/Dummy/DummyRefComponent.php
@@ -11,7 +11,7 @@
 
 #[
     Schema(SchemaType::OBJECT),
-    Property(PropertyType::STRING, "prop1", "Prop1 description", "Value 1"),
+    Property(PropertyType::STRING, "prop1", "Prop1 description", "Value 1", isObjectId: true),
     Property(PropertyType::INT, "prop2", example: "Value2"),
 ]
 class DummyRefComponent