patch null inheritance in compositions (fixes #50)

Author: wol-soft

src/PropertyProcessor/ComposedValue/AbstractComposedValueProcessor.php

@@ -16,6 +16,7 @@
 use PHPModelGenerator\Model\Validator\RequiredPropertyValidator;
 use PHPModelGenerator\PropertyProcessor\Decorator\Property\ObjectInstantiationDecorator;
 use PHPModelGenerator\PropertyProcessor\Decorator\SchemaNamespaceTransferDecorator;
+use PHPModelGenerator\PropertyProcessor\Decorator\TypeHint\ClearTypeHintDecorator;
 use PHPModelGenerator\PropertyProcessor\Decorator\TypeHint\CompositionTypeHintDecorator;
 use PHPModelGenerator\PropertyProcessor\Property\AbstractValueProcessor;
 use PHPModelGenerator\PropertyProcessor\PropertyMetaDataCollection;
@@ -120,6 +121,10 @@ protected function getCompositionProperties(PropertyInterface $property, JsonSch
         $compositionProperties = [];
         $json = $propertySchema->getJson()['propertySchema']->getJson();
 
+        // clear the base type of the property to keep only the types of the composition.
+        // This avoids e.g. "array|int[]" for a property which is known to contain always an integer array
+        $property->addTypeHintDecorator(new ClearTypeHintDecorator());
+
         foreach ($json[$propertySchema->getJson()['type']] as $compositionElement) {
             $compositionSchema = $propertySchema->getJson()['propertySchema']->withJson($compositionElement);
 
@@ -165,19 +170,24 @@ private function transferPropertyType(PropertyInterface $property, array $compos
     {
         $compositionPropertyTypes = array_values(
             array_unique(
-                array_filter(
-                    array_map(
-                        function (CompositionPropertyDecorator $property): string {
-                            return $property->getType() ? $property->getType()->getName() : '';
-                        },
-                        $compositionProperties
-                    )
+                array_map(
+                    function (CompositionPropertyDecorator $property): string {
+                        return $property->getType() ? $property->getType()->getName() : '';
+                    },
+                    $compositionProperties
                 )
             )
         );
 
-        if (count($compositionPropertyTypes) === 1 && !($this instanceof NotProcessor)) {
-            $property->setType(new PropertyType($compositionPropertyTypes[0]));
+        $nonEmptyCompositionPropertyTypes = array_values(array_filter($compositionPropertyTypes));
+
+        if (count($nonEmptyCompositionPropertyTypes) === 1 && !($this instanceof NotProcessor)) {
+            $property->setType(
+                new PropertyType(
+                    $nonEmptyCompositionPropertyTypes[0],
+                    count($compositionPropertyTypes) > 1 ? true : null
+                )
+            );
         }
     }
 

src/PropertyProcessor/Decorator/TypeHint/ClearTypeHintDecorator.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\PropertyProcessor\Decorator\TypeHint;
+
+/**
+ * Class ClearTypeHintDecorator
+ *
+ * @package PHPModelGenerator\PropertyProcessor\Decorator\Property
+ */
+class ClearTypeHintDecorator implements TypeHintDecoratorInterface
+{
+    /**
+     * @inheritdoc
+     */
+    public function decorate(string $input, bool $outputType = false): string
+    {
+        return '';
+    }
+}

src/PropertyProcessor/Property/MultiTypeProcessor.php

@@ -90,7 +90,7 @@ public function process(string $propertyName, JsonSchema $propertySchema): Prope
         $property->addTypeHintDecorator(
             new TypeHintDecorator(
                 array_map(
-                    function (PropertyInterface $subProperty): string {#
+                    function (PropertyInterface $subProperty): string {
                         return $subProperty->getTypeHint();
                     },
                     $subProperties

tests/ComposedValue/ComposedOneOfTest.php

@@ -639,4 +639,28 @@ public function validationInSetterDataProvider(): array
             ],
         ];
     }
+
+    public function testTypesForComposedPropertyWithNullBranch(): void
+    {
+        $className = $this->generateClassFromFile(
+            'OneOfNullBranch.json',
+            (new GeneratorConfiguration())->setImmutable(false)
+        );
+
+        $object = new $className([]);
+
+        $this->assertSame('int[]|null', $this->getPropertyTypeAnnotation($object, 'property'));
+
+        $this->assertSame('int[]|null', $this->getMethodReturnTypeAnnotation($object, 'getProperty'));
+        $returnType = $this->getReturnType($object, 'getProperty');
+        $this->assertSame('array', $returnType->getName());
+        // as implicit null is enabled the default value may be overwritten by a null value
+        $this->assertTrue($returnType->allowsNull());
+
+        $this->assertSame('int[]|null', $this->getMethodParameterTypeAnnotation($object, 'setProperty'));
+        $parameterType = $this->getParameterType($object, 'setProperty');
+        $this->assertSame('array', $parameterType->getName());
+        // as implicit null is enabled the default value may be overwritten by a null value
+        $this->assertTrue($parameterType->allowsNull());
+    }
 }

tests/Schema/ComposedOneOfTest/OneOfNullBranch.json

@@ -0,0 +1,18 @@
+{
+  "type": "object",
+  "properties": {
+    "property": {
+      "oneOf": [
+        {
+          "type": "array",
+          "items": {
+            "type": "integer"
+          }
+        },
+        {
+          "type": "null"
+        }
+      ]
+    }
+  }
+}