Fix type hints for multi type properties

Add null type hint via decorator instead of model render logic

Author: wol-soft

src/PropertyProcessor/Decorator/TypeHint/CompositionTypeHintDecorator.php

@@ -7,7 +7,7 @@
 use PHPModelGenerator\Model\Property\PropertyInterface;
 
 /**
- * Class ArrayTypeHintDecorator
+ * Class CompositionTypeHintDecorator
  *
  * @package PHPModelGenerator\PropertyProcessor\Decorator\Property
  */
@@ -17,7 +17,7 @@ class CompositionTypeHintDecorator implements TypeHintDecoratorInterface
     protected $nestedProperty;
 
     /**
-     * ArrayTypeHintDecorator constructor.
+     * CompositionTypeHintDecorator constructor.
      *
      * @param PropertyInterface $nestedProperty
      */
@@ -31,11 +31,6 @@ public function __construct(PropertyInterface $nestedProperty)
      */
     public function decorate(string $input): string
     {
-        // don't add the same type hint multiple times
-        if ($input && in_array($this->nestedProperty->getTypeHint(), explode('|', $input))) {
-            return $input;
-        }
-
-        return ($input ? "$input|" : '') . $this->nestedProperty->getTypeHint();
+        return (new TypeHintDecorator(explode('|', $this->nestedProperty->getTypeHint())))->decorate($input);
     }
 }

src/PropertyProcessor/Decorator/TypeHint/TypeHintDecorator.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\PropertyProcessor\Decorator\TypeHint;
+
+/**
+ * Class TypeHintDecorator
+ *
+ * @package PHPModelGenerator\PropertyProcessor\Decorator\Property
+ */
+class TypeHintDecorator implements TypeHintDecoratorInterface
+{
+    /** @var array */
+    protected $types;
+
+    /**
+     * TypeHintDecorator constructor.
+     *
+     * @param array $types
+     */
+    public function __construct(array $types)
+    {
+        $this->types = $types;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function decorate(string $input): string
+    {
+        return implode('|', array_unique(array_filter(array_merge(explode('|', $input), $this->types))));
+    }
+}

src/PropertyProcessor/Property/AbstractValueProcessor.php

@@ -8,6 +8,7 @@
 use PHPModelGenerator\Model\Property\Property;
 use PHPModelGenerator\Model\Property\PropertyInterface;
 use PHPModelGenerator\Model\Schema;
+use PHPModelGenerator\PropertyProcessor\Decorator\TypeHint\TypeHintDecorator;
 use PHPModelGenerator\PropertyProcessor\Filter\FilterProcessor;
 use PHPModelGenerator\PropertyProcessor\PropertyMetaDataCollection;
 use PHPModelGenerator\SchemaProcessor\SchemaProcessor;
@@ -55,6 +56,10 @@ public function process(string $propertyName, array $propertyData): PropertyInte
                 $this->schemaProcessor->getGeneratorConfiguration()->isImmutable()
             );
 
+        if ($this->schemaProcessor->getGeneratorConfiguration()->isImplicitNullAllowed() && !$property->isRequired()) {
+            $property->addTypeHintDecorator(new TypeHintDecorator(['null']));
+        }
+
         $this->generateValidators($property, $propertyData);
 
         if (isset($propertyData['filter'])) {

src/PropertyProcessor/Property/MultiTypeProcessor.php

@@ -10,6 +10,7 @@
 use PHPModelGenerator\Model\Validator\MultiTypeCheckValidator;
 use PHPModelGenerator\Model\Validator\TypeCheckInterface;
 use PHPModelGenerator\PropertyProcessor\Decorator\Property\PropertyTransferDecorator;
+use PHPModelGenerator\PropertyProcessor\Decorator\TypeHint\TypeHintDecorator;
 use PHPModelGenerator\PropertyProcessor\PropertyMetaDataCollection;
 use PHPModelGenerator\PropertyProcessor\PropertyProcessorFactory;
 use PHPModelGenerator\PropertyProcessor\PropertyProcessorInterface;
@@ -26,7 +27,7 @@ class MultiTypeProcessor extends AbstractValueProcessor
     /** @var PropertyProcessorInterface[] */
     protected $propertyProcessors = [];
     /** @var string[] */
-    protected $allowedPropertyTypeChecks = [];
+    protected $allowedPropertyTypes = [];
     /** @var string[] */
     protected $checks = [];
 
@@ -81,13 +82,15 @@ public function process(string $propertyName, array $propertyData): PropertyInte
 
         $this->processSubProperties($propertyName, $propertyData, $property);
 
-        if (empty($this->allowedPropertyTypeChecks)) {
+        if (empty($this->allowedPropertyTypes)) {
             return $property;
         }
 
+        $property->addTypeHintDecorator(new TypeHintDecorator($this->allowedPropertyTypes));
+
         return $property->addValidator(
             new MultiTypeCheckValidator(
-                array_unique($this->allowedPropertyTypeChecks),
+                array_unique($this->allowedPropertyTypes),
                 $property,
                 $this->isImplicitNullAllowed($property)
             ),
@@ -108,7 +111,7 @@ protected function transferValidators(PropertyInterface $source, PropertyInterfa
 
             // filter out type checks to create a single type check which covers all allowed types
             if ($validator instanceof TypeCheckInterface) {
-                array_push($this->allowedPropertyTypeChecks, ...$validator->getTypes());
+                array_push($this->allowedPropertyTypes, ...$validator->getTypes());
 
                 continue;
             }

src/Templates/Model.phptpl

@@ -22,7 +22,7 @@ class {{ class }} implements \PHPModelGenerator\Interfaces\JSONModelInterface
     {% if generatorConfiguration.hasSerializationEnabled() %}use \PHPModelGenerator\Traits\SerializableTrait;{% endif %}
 
     {% foreach properties as property %}
-        /** @var {{ property.getTypeHint(true) }}{% if viewHelper.implicitNull(property) %}|null{% endif %}{% if property.getDescription() %} {{ property.getDescription() }}{% endif %} */
+        /**{% if property.getTypeHint(true) %} @var {{ property.getTypeHint(true) }}{% endif %}{% if property.getDescription() %} {{ property.getDescription() }}{% endif %} */
         protected ${{ property.getAttribute() }}{% if not viewHelper.isNull(property.getDefaultValue()) %} = {{ property.getDefaultValue() }}{% endif %};
     {% endforeach %}
     /** @var array */
@@ -99,7 +99,7 @@ class {{ class }} implements \PHPModelGenerator\Interfaces\JSONModelInterface
          *
          * {% if property.getDescription() %}{{ property.getDescription() }}{% endif %}
          *
-         * @return {{ property.getTypeHint(true) }}{% if viewHelper.implicitNull(property) %}|null{% endif %}
+         * {% if property.getTypeHint(true) %}@return {{ property.getTypeHint(true) }}{% endif %}
          */
         public function get{{ viewHelper.ucfirst(property.getAttribute()) }}()
             {% if property.getType(true) %}: {% if not property.isRequired() %}?{% endif %}{{ property.getType(true) }}{% endif %}
@@ -111,14 +111,14 @@ class {{ class }} implements \PHPModelGenerator\Interfaces\JSONModelInterface
             /**
              * Set the value of {{ property.getName() }}.
              *
-             * @param {{ property.getTypeHint() }}{% if viewHelper.implicitNull(property) %}|null{% endif %} ${{ property.getAttribute() }}{% if property.getDescription() %} {{ property.getDescription() }}{% endif %}
+             * @param {{ property.getTypeHint() }} ${{ property.getAttribute() }}{% if property.getDescription() %} {{ property.getDescription() }}{% endif %}
              *
              * {% if property.getValidators() %}@throws {% if generatorConfiguration.collectErrors() %}{{ viewHelper.getSimpleClassName(generatorConfiguration.getErrorRegistryClass()) }}{% else %}ValidationException{% endif %}{% endif %}
              *
              * @return self
              */
             public function set{{ viewHelper.ucfirst(property.getAttribute()) }}(
-                {% if property.getType() %}{% if viewHelper.implicitNull(property) %}?{% endif %}{{ property.getType() }} {% endif %}${{ property.getAttribute() }}
+                {% if property.getType() %}{% if viewHelper.isPropertyNullable(property) %}?{% endif %}{{ property.getType() }} {% endif %}${{ property.getAttribute() }}
             ): self {
                 $value = $modelData['{{ property.getName() }}'] = ${{ property.getAttribute() }};
 

src/Utils/RenderHelper.php

@@ -100,7 +100,7 @@ public function validationError(PropertyValidatorInterface $validator): string
         return "throw $exceptionConstructor;";
     }
 
-    public function implicitNull(PropertyInterface $property): bool
+    public function isPropertyNullable(PropertyInterface $property): bool
     {
         return $this->generatorConfiguration->isImplicitNullAllowed() && !$property->isRequired();
     }

tests/Objects/MultiTypePropertyTest.php

@@ -40,6 +40,9 @@ public function testValidProvidedValuePassesValidation($propertyValue): void
 
         $object = new $className(['property' => $propertyValue]);
         $this->assertEquals($propertyValue, $object->getProperty());
+
+        $this->assertSame('null|float|string|array', $this->getPropertyType($object, 'property'));
+        $this->assertSame('null|float|string|array', $this->getMethodReturnType($object, 'getProperty'));
     }
 
     public function validValueDataProvider(): array