Import reused classes for objects nested in a combined schema

Author: wol-soft

src/Model/Schema.php

@@ -4,13 +4,12 @@
 
 namespace PHPModelGenerator\Model;
 
-use Exception;
-use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Model\Property\Property;
 use PHPModelGenerator\Model\Property\PropertyInterface;
 use PHPModelGenerator\Model\SchemaDefinition\SchemaDefinitionDictionary;
 use PHPModelGenerator\Model\Validator\PropertyValidator;
 use PHPModelGenerator\Model\Validator\PropertyValidatorInterface;
+use PHPModelGenerator\PropertyProcessor\Decorator\SchemaNamespaceTransferDecorator;
 
 /**
  * Class Schema
@@ -31,6 +30,8 @@ class Schema
     protected $baseValidators = [];
     /** @var array */
     protected $usedClasses = [];
+    /** @var SchemaNamespaceTransferDecorator[] */
+    protected $namespaceTransferDecorators = [];
 
     /** @var SchemaDefinitionDictionary */
     protected $schemaDefinitionDictionary;
@@ -129,11 +130,29 @@ public function addUsedClass(string $path): self
         return $this;
     }
 
+    /**
+     * @param SchemaNamespaceTransferDecorator $decorator
+     *
+     * @return $this
+     */
+    public function addNamespaceTransferDecorator(SchemaNamespaceTransferDecorator $decorator): self
+    {
+        $this->namespaceTransferDecorators[] = $decorator;
+
+        return $this;
+    }
+
     /**
      * @return array
      */
     public function getUsedClasses(): array
     {
-        return $this->usedClasses;
+        $usedClasses = $this->usedClasses;
+
+        foreach ($this->namespaceTransferDecorators as $decorator) {
+            array_push($usedClasses, ...$decorator->resolve());
+        }
+
+        return $usedClasses;
     }
 }

src/PropertyProcessor/ComposedValue/AbstractComposedValueProcessor.php

@@ -13,6 +13,7 @@
 use PHPModelGenerator\Model\Validator\ComposedPropertyValidator;
 use PHPModelGenerator\Model\Validator\RequiredPropertyValidator;
 use PHPModelGenerator\PropertyProcessor\Decorator\Property\ObjectInstantiationDecorator;
+use PHPModelGenerator\PropertyProcessor\Decorator\SchemaNamespaceTransferDecorator;
 use PHPModelGenerator\PropertyProcessor\Decorator\TypeHint\CompositionTypeHintDecorator;
 use PHPModelGenerator\PropertyProcessor\Property\AbstractValueProcessor;
 use PHPModelGenerator\PropertyProcessor\PropertyCollectionProcessor;
@@ -188,6 +189,8 @@ protected function transferPropertiesToMergedSchema(Schema $mergedPropertySchema
                     })
                 );
             }
+
+            $mergedPropertySchema->addNamespaceTransferDecorator(new SchemaNamespaceTransferDecorator($this->schema));
         }
     }
 

src/PropertyProcessor/Decorator/SchemaNamespaceTransferDecorator.php

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\PropertyProcessor\Decorator;
+
+use PHPModelGenerator\Model\Property\PropertyInterface;
+use PHPModelGenerator\Model\Schema;
+
+/**
+ * Class SchemaNamespaceTransferDecorator
+ */
+class SchemaNamespaceTransferDecorator
+{
+    /** @var Schema */
+    private $schema;
+    /** @var bool */
+    private $fetchPropertyImports;
+
+    /**
+     * SchemaNamespaceTransferDecorator constructor.
+     *
+     * @param Schema $schema
+     * @param bool   $fetchPropertyImports
+     */
+    public function __construct(Schema $schema, bool $fetchPropertyImports = false)
+    {
+        $this->schema = $schema;
+        $this->fetchPropertyImports = $fetchPropertyImports;
+    }
+
+    /**
+     * Get all used classes to use the referenced schema
+     *
+     * @return array
+     */
+    public function resolve(): array
+    {
+        $usedClasses = $this->schema->getUsedClasses();
+
+        if ($this->fetchPropertyImports) {
+            foreach ($this->schema->getProperties() as $property) {
+                array_push($usedClasses, ...$this->getUsedClasses($property));
+            }
+        }
+
+        return $usedClasses;
+    }
+
+    /**
+     * Fetch required imports for handling a property
+     *
+     * @param PropertyInterface $property
+     *
+     * @return array
+     */
+    private function getUsedClasses(PropertyInterface $property): array
+    {
+        $classes = array_filter(
+            explode('|', str_replace('[]', '', $property->getTypeHint())),
+            function (string $type): bool {
+                return !in_array($type, ['null', 'mixed', 'string', 'int', 'bool', 'float', 'array']);
+            }
+        );
+
+        array_walk($classes, function (string &$class): void {
+            $class = "{$this->schema->getClassPath()}\\$class";
+        });
+
+        return $classes;
+    }
+}

src/PropertyProcessor/Property/ObjectProcessor.php

@@ -7,6 +7,7 @@
 use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Model\Property\PropertyInterface;
 use PHPModelGenerator\PropertyProcessor\Decorator\Property\ObjectInstantiationDecorator;
+use PHPModelGenerator\PropertyProcessor\Decorator\SchemaNamespaceTransferDecorator;
 
 /**
  * Class ObjectProcessor
@@ -42,6 +43,7 @@ public function process(string $propertyName, array $propertyData): PropertyInte
 
         if ($schema->getClassPath() !== $this->schema->getClassPath()) {
             $this->schema->addUsedClass("{$schema->getClassPath()}\\{$schema->getClassName()}");
+            $this->schema->addNamespaceTransferDecorator(new SchemaNamespaceTransferDecorator($schema, true));
         }
 
         $property

tests/Basic/BasicSchemaGenerationTest.php

@@ -276,14 +276,16 @@ public function testIdenticalSchemasAreMappedToOneClassFromDifferentNamespaces()
         }
 
         $subClass1FQCN = '\\Application\\SubFolder1\\SubSchema';
-        $subObject1 = new $subClass1FQCN(['object1' => ['property1' => 'Hello']]);
+        $subObject1 = new $subClass1FQCN(['object1' => ['property1' => 'Hello'], 'property3' => 3]);
 
         $this->assertSame('Hello', $subObject1->getObject1()->getProperty1());
+        $this->assertSame(3, $subObject1->getProperty3());
 
         $subClass2FQCN = '\\Application\\SubFolder2\\SubSchema';
-        $subObject2 = new $subClass2FQCN(['object1' => ['property1' => 'Goodbye']]);
+        $subObject2 = new $subClass2FQCN(['object1' => ['property1' => 'Goodbye'], 'property3' => true]);
 
         $this->assertSame('Goodbye', $subObject2->getObject1()->getProperty1());
+        $this->assertSame(true, $subObject2->getProperty3());
 
         $this->assertSame(get_class($subObject1->getObject1()), get_class($subObject2->getObject1()));
 

tests/Schema/BasicSchemaGenerationTest/IdenticalSubSchemaDifferentNamespace/SubFolder1/SubSchema.json

@@ -1,19 +1,31 @@
 {
-  "type": "object",
-  "properties": {
-    "object1": {
+  "allOf": [
+    {
       "type": "object",
       "properties": {
-        "property1": {
-          "type": "string"
-        },
-        "property2": {
-          "allOf": []
+        "object1": {
+          "type": "object",
+          "properties": {
+            "property1": {
+              "type": "string"
+            },
+            "property2": {
+              "allOf": []
+            }
+          },
+          "required": [
+            "property1"
+          ]
         }
-      },
-      "required": [
-        "property1"
-      ]
+      }
+    },
+    {
+      "type": "object",
+      "properties": {
+        "property3": {
+          "type": "integer"
+        }
+      }
     }
-  }
+  ]
 }

tests/Schema/BasicSchemaGenerationTest/IdenticalSubSchemaDifferentNamespace/SubFolder2/SubSchema.json

@@ -1,19 +1,31 @@
 {
-  "type": "object",
-  "properties": {
-    "object1": {
+  "allOf": [
+    {
       "type": "object",
       "properties": {
-        "property1": {
-          "type": "string"
-        },
-        "property2": {
-          "allOf": []
+        "object1": {
+          "type": "object",
+          "properties": {
+            "property1": {
+              "type": "string"
+            },
+            "property2": {
+              "allOf": []
+            }
+          },
+          "required": [
+            "property1"
+          ]
         }
-      },
-      "required": [
-        "property1"
-      ]
+      }
+    },
+    {
+      "type": "object",
+      "properties": {
+        "property3": {
+          "type": "boolean"
+        }
+      }
     }
-  }
+  ]
 }