Merge pull request #98 from php-api-clients/correctly-detect-arrays-of-schema-properties

Correctly detect arrays of schema properties

Author: WyriHaximus

src/Gatherer/Property.php

@@ -37,84 +37,31 @@ public static function gather(
             '',
         ], $propertyName);
 
-        $type = $property->type;
-        $nullable = !$required;
-
-        if (
-            is_array($type) &&
-            count($type) === 2 &&
-            (
-                in_array(null, $type) ||
-                in_array("null", $type)
-            )
-        ) {
-            foreach ($type as $pt) {
-                if ($pt !== null && $pt !== "null") {
-                    $type = $pt;
-                    break;
-                }
-            }
-
-            $nullable = true;
-        }
-
-        if (is_string($type)) {
-            $type = str_replace([
-                'integer',
-                'number',
-                'any',
-                'null',
-                'boolean',
-            ], [
-                'int',
-                'int',
-                '',
-                '',
-                'bool',
-            ], $type);
-        } else {
-            $type = '';
-        }
-        if ($type === '') {
-            $type = new PropertyType(
-                'scalar',
-                'mixed'
-            );
-            $nullable = false;
-        } else if ($type === 'object') {
-            $type = new PropertyType(
-                'object',
-                Schema::gather(
-                    $schemaRegistry->get($property, $className . '\\' . Utils::className($propertyName)),
-                    $property,
-                    $schemaRegistry,
-                )
-            );
+        $type = Type::gather(
+            $className,
+            $propertyName,
+            $property,
+            $required,
+            $schemaRegistry,
+        );
+        if ($type->type=== 'object') {
             $exampleData = ($exampleData ?? []) + $type->payload->example;
         } else {
             if ($exampleData === null) {
-                if ($type === 'int') {
+                if ($type->type === 'int') {
                     $exampleData = 13;
-                } elseif ($type === 'bool') {
+                } elseif ($type->type === 'bool') {
                     $exampleData = false;
                 } else {
                     $exampleData = 'generated_' . $propertyName;
                 }
             }
-            $type = new PropertyType(
-                'scalar',
-                $type
-            );
         }
 
-        if ($type->payload === 'array') {
+        if ($type->type === 'array') {
             $exampleData = [$exampleData];
         }
 
-        if (!is_array($type)) {
-            $type = [$type];
-        }
-
-        return new \ApiClients\Tools\OpenApiClientGenerator\Representation\Property($propertyName, $property->description ?? '', $exampleData, $type, $nullable);
+        return new \ApiClients\Tools\OpenApiClientGenerator\Representation\Property($propertyName, $property->description ?? '', $exampleData, [$type], $type->nullable);
     }
 }

src/Gatherer/Type.php

@@ -0,0 +1,93 @@
+<?php
+
+namespace ApiClients\Tools\OpenApiClientGenerator\Gatherer;
+
+use ApiClients\Tools\OpenApiClientGenerator\Utils;
+use ApiClients\Tools\OpenApiClientGenerator\Representation\PropertyType;
+use ApiClients\Tools\OpenApiClientGenerator\Registry\Schema as SchemaRegistry;
+use cebe\openapi\spec\Schema as baseSchema;
+use Jawira\CaseConverter\Convert;
+
+final class Type
+{
+    public static function gather(
+        string $className,
+        string $propertyName,
+        baseSchema $property,
+        bool $required,
+        SchemaRegistry $schemaRegistry,
+    ): PropertyType {
+        $type = $property->type;
+        $nullable = !$required;
+
+        if ($type === 'array') {
+            return new PropertyType(
+                'array',
+                Type::gather($className, $propertyName, $property->items, $required, $schemaRegistry),
+                $nullable
+            );
+        }
+
+        if (
+            is_array($type) &&
+            count($type) === 2 &&
+            (
+                in_array(null, $type) ||
+                in_array("null", $type)
+            )
+        ) {
+            foreach ($type as $pt) {
+                if ($pt !== null && $pt !== "null") {
+                    $type = $pt;
+                    break;
+                }
+            }
+
+            $nullable = true;
+        }
+
+        if (is_string($type)) {
+            $type = str_replace([
+                'integer',
+                'number',
+                'any',
+                'null',
+                'boolean',
+            ], [
+                'int',
+                'int',
+                '',
+                '',
+                'bool',
+            ], $type);
+        } else {
+            $type = '';
+        }
+
+        if ($type === '') {
+            return new PropertyType(
+                'scalar',
+                'mixed',
+                false,
+            );
+        }
+
+        if ($type === 'object') {
+            return new PropertyType(
+                'object',
+                Schema::gather(
+                    $schemaRegistry->get($property, $className . '\\' . Utils::className($propertyName)),
+                    $property,
+                    $schemaRegistry,
+                ),
+                $nullable,
+            );
+        }
+
+        return new PropertyType(
+            'scalar',
+            $type,
+            $nullable,
+        );
+    }
+}

src/Generator/Schema.php

@@ -95,6 +95,12 @@ public static function generate(string $namespace, \ApiClients\Tools\OpenApiClie
 
             $types = [];
             foreach ($property->type as $type) {
+                if ($type->type === 'array') {
+                    $propertyDocBlock[] = '@var array<' . ($type->payload->payload instanceof \ApiClients\Tools\OpenApiClientGenerator\Representation\Schema ? 'Schema\\' . $type->payload->payload->className : $type->payload->payload) . '>';
+                    $types[] = 'array';
+                    continue;
+                }
+
                 if ($type->payload instanceof \ApiClients\Tools\OpenApiClientGenerator\Representation\Schema) {
                     $types[] = 'Schema\\' . $type->payload->className;
                     continue;

src/Representation/PropertyType.php

@@ -6,7 +6,8 @@ final class PropertyType
 {
     public function __construct(
         public readonly string $type,
-        public readonly string|Schema $payload,
+        public readonly string|Schema|PropertyType $payload,
+        public readonly bool $nullable,
     ){
     }
 }