Fix array type hints, add type hint tests

Author: wol-soft

src/PropertyProcessor/Decorator/TypeHint/ArrayTypeHintDecorator.php

@@ -31,6 +31,8 @@ public function __construct(PropertyInterface $nestedProperty)
      */
     public function decorate(string $input): string
     {
-        return "{$this->nestedProperty->getTypeHint()}[]";
+        return implode('|', array_map(function (string $typeHint): string {
+            return "{$typeHint}[]";
+        }, explode('|', $this->nestedProperty->getTypeHint())));
     }
 }

src/PropertyProcessor/Property/AbstractValueProcessor.php

@@ -56,10 +56,6 @@ 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/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 %}
-        /**{% if property.getTypeHint(true) %} @var {{ property.getTypeHint(true) }}{% endif %}{% if property.getDescription() %} {{ property.getDescription() }}{% endif %} */
+        /**{% if viewHelper.getTypeHintAnnotation(property, true) %} @var {{ viewHelper.getTypeHintAnnotation(property, 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 %}
          *
-         * {% if property.getTypeHint(true) %}@return {{ property.getTypeHint(true) }}{% endif %}
+         * {% if viewHelper.getTypeHintAnnotation(property, true) %}@return {{ viewHelper.getTypeHintAnnotation(property, true) }}{% endif %}
          */
         public function get{{ viewHelper.ucfirst(property.getAttribute()) }}()
             {% if property.getType(true) %}: {% if viewHelper.isPropertyNullable(property) %}?{% endif %}{{ property.getType(true) }}{% endif %}
@@ -111,14 +111,14 @@ class {{ class }} implements \PHPModelGenerator\Interfaces\JSONModelInterface
             /**
              * Set the value of {{ property.getName() }}.
              *
-             * @param {{ property.getTypeHint() }} ${{ property.getAttribute() }}{% if property.getDescription() %} {{ property.getDescription() }}{% endif %}
+             * @param {{ viewHelper.getTypeHintAnnotation(property) }} ${{ 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.isPropertyNullable(property) %}?{% endif %}{{ property.getType() }} {% endif %}${{ property.getAttribute() }}
+                {% if property.getType() %}{% if viewHelper.isPropertyNullable(property, true) %}?{% endif %}{{ property.getType() }} {% endif %}${{ property.getAttribute() }}
             ): self {
                 $value = $modelData['{{ property.getName() }}'] = ${{ property.getAttribute() }};
 

src/Utils/RenderHelper.php

@@ -100,8 +100,23 @@ public function validationError(PropertyValidatorInterface $validator): string
         return "throw $exceptionConstructor;";
     }
 
-    public function isPropertyNullable(PropertyInterface $property): bool
+    public function isPropertyNullable(PropertyInterface $property, bool $setter = false): bool
     {
-        return $this->generatorConfiguration->isImplicitNullAllowed() && !$property->isRequired();
+        return (!$setter || $this->generatorConfiguration->isImplicitNullAllowed()) && !$property->isRequired();
+    }
+
+    public function getTypeHintAnnotation(PropertyInterface $property, bool $outputType = false): string
+    {
+        $typeHint = $property->getTypeHint($outputType);
+
+        if (!$typeHint) {
+            return '';
+        }
+
+        if ((!$outputType || $this->generatorConfiguration->isImplicitNullAllowed()) && !$property->isRequired()) {
+            $typeHint = implode('|', array_unique(array_merge(explode('|', $typeHint), ['null'])));
+        }
+
+        return $typeHint;
     }
 }

tests/AbstractPHPModelGeneratorTest.php

@@ -19,6 +19,7 @@
 use RecursiveDirectoryIterator;
 use RecursiveIteratorIterator;
 use ReflectionClass;
+use ReflectionType;
 
 /**
  * Class AbstractPHPModelGeneratorTest
@@ -132,6 +133,7 @@ protected function generateClassFromFile(
      * @param array                       $values
      * @param GeneratorConfiguration|null $generatorConfiguration
      * @param bool                        $escape
+     * @param bool                        $implicitNull
      *
      * @return string
      *
@@ -143,7 +145,8 @@ protected function generateClassFromFileTemplate(
         string $file,
         array $values,
         GeneratorConfiguration $generatorConfiguration = null,
-        bool $escape = true
+        bool $escape = true,
+        bool $implicitNull = true
     ): string {
         return $this->generateClass(
             call_user_func_array(
@@ -158,7 +161,9 @@ function ($item) use ($escape) {
                     )
                 )
             ),
-            $generatorConfiguration
+            $generatorConfiguration,
+            false,
+            $implicitNull
         );
     }
 
@@ -440,6 +445,16 @@ protected function getMethodReturnTypeAnnotation($object, string $method): strin
         return $matches[1];
     }
 
+    protected function getParameterType($object, string $method): ReflectionType
+    {
+        return (new ReflectionClass($object))->getMethod($method)->getParameters()[0]->getType();
+    }
+
+    protected function getReturnType($object, string $method): ReflectionType
+    {
+        return (new ReflectionClass($object))->getMethod($method)->getReturnType();
+    }
+
     protected function getGeneratedFiles(): array
     {
         return $this->generatedFiles;

tests/Basic/BasicSchemaGenerationTest.php

@@ -43,11 +43,12 @@ public function testGetterAndSetterAreGeneratedForMutableObjects(bool $implicitN
         $this->assertSame('Bye', $object->getProperty());
 
         // test if the property is typed correctly
-        $returnType = (new ReflectionMethod($object, 'getProperty'))->getReturnType();
+        $returnType = $this->getReturnType($object, 'getProperty');
         $this->assertSame('string', $returnType->getName());
-        $this->assertSame($implicitNull, $returnType->allowsNull());
+        // as the property is optional it may contain an initial null value
+        $this->assertTrue($returnType->allowsNull());
 
-        $setType = (new ReflectionMethod($object, 'setProperty'))->getParameters()[0]->getType();
+        $setType = $this->getParameterType($object, 'setProperty');
         $this->assertSame('string', $setType->getName());
         $this->assertSame($implicitNull, $setType->allowsNull());
     }

tests/ComposedValue/ComposedAnyOfTest.php

@@ -143,7 +143,7 @@ public function annotationDataProvider(): array
         return [
             'Multiple scalar types (no merged property)' => [
                 'AnyOfType.json',
-                '/^null\|string\|int\|bool$/',
+                '/^string\|int\|bool\|null$/',
                 1,
             ],
             'Multiple scalar types required (no merged property)' => [
@@ -153,17 +153,17 @@ public function annotationDataProvider(): array
             ],
             'Object with scalar type (no merged property - redirect to generated object)' => [
                 'ReferencedObjectSchema.json',
-                '/^null\|string\|ComposedAnyOfTest[\w]*Property[\w]*$/',
+                '/^string\|ComposedAnyOfTest[\w]*Property[\w]*\|null$/',
                 2,
             ],
             'Multiple objects (merged property created)' => [
                 'ReferencedObjectSchema2.json',
-                '/^null\|ComposedAnyOfTest[\w]*_Merged_[\w]*$/',
+                '/^ComposedAnyOfTest[\w]*_Merged_[\w]*\|null$/',
                 4,
             ],
             'Scalar type and multiple objects (merged property created)' => [
                 'ReferencedObjectSchema3.json',
-                '/^null\|string\|ComposedAnyOfTest[\w]*_Merged_[\w]*$/',
+                '/^string\|ComposedAnyOfTest[\w]*_Merged_[\w]*\|null$/',
                 4,
             ],
         ];