Implement schema intern references via ID

Author: wol-soft

src/Model/SchemaDefinition.php

@@ -97,7 +97,6 @@ public function resolveReference(
             }
         }
 
-
         return new PropertyProxy($this->resolvedPaths, $key);
     }
 }

src/PropertyProcessor/ComposedValue/AbstractComposedValueProcessor.php

@@ -76,5 +76,5 @@ protected function generateValidators(PropertyInterface $property, array $proper
      *
      * @return string
      */
-    abstract function getComposedValueValidation(int $composedElements): string;
+    abstract protected function getComposedValueValidation(int $composedElements): string;
 }

src/PropertyProcessor/ComposedValue/AllOfProcessor.php

@@ -12,7 +12,7 @@ class AllOfProcessor extends AbstractComposedPropertiesProcessor
     /**
      * @inheritdoc
      */
-    function getComposedValueValidation(int $composedElements): string
+    protected function getComposedValueValidation(int $composedElements): string
     {
         return "\$succeededCompositionElements === $composedElements";
     }

src/PropertyProcessor/ComposedValue/AnyOfProcessor.php

@@ -12,7 +12,7 @@ class AnyOfProcessor extends AbstractComposedPropertiesProcessor
     /**
      * @inheritdoc
      */
-    function getComposedValueValidation(int $composedElements): string
+    protected function getComposedValueValidation(int $composedElements): string
     {
         return "\$succeededCompositionElements > 0";
     }

src/PropertyProcessor/ComposedValue/NotProcessor.php

@@ -26,7 +26,7 @@ protected function generateValidators(PropertyInterface $property, array $proper
     /**
      * @inheritdoc
      */
-    function getComposedValueValidation(int $composedElements): string
+    protected function getComposedValueValidation(int $composedElements): string
     {
         return '$succeededCompositionElements === 0';
     }

src/PropertyProcessor/ComposedValue/OneOfProcessor.php

@@ -12,7 +12,7 @@ class OneOfProcessor extends AbstractComposedPropertiesProcessor
     /**
      * @inheritdoc
      */
-    function getComposedValueValidation(int $composedElements): string
+    protected function getComposedValueValidation(int $composedElements): string
     {
         return '$succeededCompositionElements === 1';
     }

src/PropertyProcessor/Property/ArrayProcessor.php

@@ -100,7 +100,7 @@ private function addUniqueItemsValidation(PropertyInterface $property, array $pr
      * Add the validator to check if the items inside an array are unique
      *
      * @param PropertyInterface $property
-     * @param array    $propertyData
+     * @param array             $propertyData
      *
      * @throws SchemaException
      */

src/PropertyProcessor/Property/BaseProcessor.php

@@ -124,6 +124,7 @@ protected function setUpDefinitionDictionary(array $propertyData)
                 continue;
             }
 
+            // add the root nodes of the schema to resolve path references
             $this->schema->addDefinition(
                 $key,
                 new SchemaDefinition(
@@ -133,6 +134,35 @@ protected function setUpDefinitionDictionary(array $propertyData)
                 )
             );
         }
+
+        $this->fetchDefinitionsById($propertyData);
+    }
+
+    /**
+     * Fetch all schema definitions with an ID for direct references
+     *
+     * @param array $schema
+     */
+    protected function fetchDefinitionsById(array $schema)
+    {
+        if (isset($schema['$id'])) {
+            $this->schema->addDefinition(
+                $schema['$id'],
+                new SchemaDefinition(
+                    $schema,
+                    $this->schemaProcessor,
+                    $this->schema
+                )
+            );
+        }
+
+        foreach ($schema as $item) {
+            if (!is_array($item)) {
+                continue;
+            }
+
+            $this->fetchDefinitionsById($item);
+        }
     }
 
     /**

src/PropertyProcessor/Property/ReferenceProcessor.php

@@ -7,6 +7,7 @@
 use Exception;
 use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Model\Property\PropertyInterface;
+use PHPModelGenerator\Model\SchemaDefinition;
 
 /**
  * Class ConstProcessor
@@ -17,26 +18,58 @@ class ReferenceProcessor extends AbstractTypedValueProcessor
 {
     /**
      * @inheritdoc
+     *
+     * @throws SchemaException
      */
     public function process(string $propertyName, array $propertyData): PropertyInterface
     {
-        if (strpos($propertyData['$ref'], '#') === 0) {
-            $path = explode('/', $propertyData['$ref']);
+        $reference = $propertyData['$ref'];
+
+        if ($this->schema->getDefinition($reference)) {
+            return $this->resolveDefinition($propertyName, $this->schema->getDefinition($reference), $reference);
+        }
+
+        if (strpos($reference, '#') === 0 && strpos($reference, '/')) {
+            $path = explode('/', $reference);
             array_shift($path);
 
-            $definition = $this->schema->getDefinition(array_shift($path));
+            return $this->resolveDefinition(
+                $propertyName,
+                $this->schema->getDefinition(array_shift($path)),
+                $reference,
+                $path
+            );
+        }
 
-            if ($definition) {
-                try {
-                    return $definition->resolveReference($propertyName, $path, $this->propertyCollectionProcessor);
-                } catch (Exception $exception) {
-                    throw new SchemaException("Unresolved Reference: {$propertyData['$ref']}", 0, $exception);
-                }
-            }
+        throw new SchemaException("Unresolved Reference: $reference");
+    }
 
-            throw new SchemaException("Unresolved Reference: {$propertyData['$ref']}");
+    /**
+     * Resolve a given definition into a Property
+     *
+     * @param string                $propertyName
+     * @param SchemaDefinition|null $definition
+     * @param string                $reference
+     * @param array                 $path
+     *
+     * @return PropertyInterface
+     *
+     * @throws SchemaException
+     */
+    protected function resolveDefinition(
+        string $propertyName,
+        ?SchemaDefinition $definition,
+        string $reference,
+        array $path = []
+    ): PropertyInterface {
+        if ($definition) {
+            try {
+                return $definition->resolveReference($propertyName, $path, $this->propertyCollectionProcessor);
+            } catch (Exception $exception) {
+                throw new SchemaException("Unresolved Reference: $reference", 0, $exception);
+            }
         }
 
-        throw new SchemaException("Unsupported Reference: {$propertyData['$ref']}");
+        throw new SchemaException("Unresolved Reference: $reference");
     }
 }

tests/AbstractPHPModelGeneratorTest.php

@@ -104,6 +104,10 @@ public function generateObjectFromFile(string $file, GeneratorConfiguration $gen
      * @param bool                        $escape
      *
      * @return string
+     *
+     * @throws FileSystemException
+     * @throws RenderException
+     * @throws SchemaException
      */
     public function generateObjectFromFileTemplate(
         string $file,