Add support for mixed and ReflectionUnionType (#73)

Co-authored-by: Jasper Smulders <jsmulders@hostnet.nl>

Author: JasperS2307

.github/workflows/main.yaml

@@ -11,7 +11,7 @@ jobs:
 
     strategy:
       matrix:
-        php-versions: ['7.3', '7.4', '8.0']
+        php-versions: ['8.0', '8.1']
     name: PHP ${{ matrix.php-versions }}
     steps:
       -   uses: actions/checkout@v2

composer.json

@@ -4,7 +4,7 @@
     "description": "Installer for all the Hostnet Doctrine entity libraries",
     "license":     "MIT",
     "require": {
-        "php":                         ">=7.3",
+        "php":                         "^8.0",
         "composer-plugin-api":         "^2.0.0",
         "doctrine/annotations":        "^1.13.2",
         "phpdocumentor/type-resolver": "^1.4.0",

src/ReflectionMethod.php

@@ -67,12 +67,10 @@ public function getReturnType(): ?ReflectionType
         }
 
         if ($type = $this->method->getReturnType()) {
-            // Self is not valid when used in different places.
-            if ('self' === $type->getName()) {
-                return null;
-            }
+            $reflection_type = new ReflectionType($type);
 
-            return new ReflectionType($type);
+            // Self is not valid when used in different places.
+            return false === \strpos($reflection_type->getName(), 'self') ? $reflection_type : null;
         }
 
         return null;

src/ReflectionParameter.php

@@ -88,12 +88,7 @@ public function isPassedByReference(): bool
         return $this->parameter->isPassedByReference();
     }
 
-    /**
-     * @return mixed
-     *
-     * @phpcsSuppress SlevomatCodingStandard.TypeHints.ReturnTypeHint
-     */
-    public function getDefaultValue()
+    public function getDefaultValue(): mixed
     {
         return $this->parameter->getDefaultValue();
     }

src/ReflectionType.php

@@ -20,18 +20,30 @@ public function __construct(\ReflectionType $type)
 
     public function getName(): string
     {
-        $name = $this->type->getName();
+        if ($this->type instanceof \ReflectionUnionType) {
+            $names = [];
+            foreach ($this->type->getTypes() as $type) {
+                $names[] = $this->resolveName($type->getName());
+            }
 
-        // Some types can not be qualified
-        if (in_array($name, self::NON_QUALIFIED_TYPES, true)) {
-            return $name;
+            return implode('|', $names);
         }
 
-        return '\\' . $name;
+        return $this->resolveName($this->type->getName());
     }
 
     public function allowsNull(): bool
     {
         return $this->type->allowsNull();
     }
+
+    private function resolveName(string $name): string
+    {
+        // Some types can not be qualified
+        if (in_array($name, self::NON_QUALIFIED_TYPES, true)) {
+            return $name;
+        }
+
+        return '\\' . $name;
+    }
 }

src/ReflectionTypeInterface.php

@@ -19,6 +19,7 @@ interface ReflectionTypeInterface
         'float',
         'int',
         'string',
+        'mixed',
     ];
 
     public function getName(): string;

src/Resources/templates/interface.php.twig

@@ -14,7 +14,7 @@ interface {{ class_name }}Interface{% if parent %} extends {{ parent }}Interface
     {{ method.docComment | raw }}
     public function {{ method.name }}({% include 'parameters.php.twig' with { parameters: method.parameters } %})
     {%- if method.returnType -%}
-        : {% if method.returnType.allowsNull %}?{% endif %}{{ method.returnType.name }}
+        : {% if method.returnType.allowsNull and method.returnType.name != "mixed" %}?{% endif %}{{ method.returnType.name }}
     {%- endif -%}
     ;
 {% endif %}

src/Resources/templates/parameters.php.twig

@@ -3,7 +3,7 @@
         {% if parameter.allowsNull() -%}
             {% set is_obligatory = not parameter.isOptional() -%}
             {% set has_actual_default_value = parameter.isDefaultValueAvailable() and parameter.defaultValue is not null -%}
-            {% if is_obligatory or has_actual_default_value -%}
+            {% if (is_obligatory or has_actual_default_value) and parameter.type.name != "mixed" -%}
                 ?
             {%- endif -%}
         {% endif -%}

test/Fixtures/ReflectionReturnSelf.php

@@ -0,0 +1,10 @@
+<?php
+namespace Hostnet\Component\EntityPlugin\Fixtures;
+
+class ReflectionReturnSelf
+{
+    public function docBlock(): self
+    {
+        return new self();
+    }
+}

test/ReflectionMethodTest.php

@@ -8,6 +8,7 @@
 
 use Hostnet\Component\EntityPlugin\Fixtures\Reflection;
 use Hostnet\Component\EntityPlugin\Fixtures\ReflectionReturn;
+use Hostnet\Component\EntityPlugin\Fixtures\ReflectionReturnSelf;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -62,9 +63,15 @@ public function testGetReturnType(): void
     {
         $this->assertEquals(null, $this->method->getReturnType());
 
-        if (PHP_MAJOR_VERSION >= 7) {
-            $php7_method = new ReflectionMethod(new \ReflectionMethod(ReflectionReturn::class, 'docBlock'));
-            $this->assertEquals('array', $php7_method->getReturnType()->getName());
-        }
+        $php7_method = new ReflectionMethod(new \ReflectionMethod(ReflectionReturn::class, 'docBlock'));
+        $this->assertEquals('array', $php7_method->getReturnType()->getName());
+    }
+
+    public function testGetReturnTypeSelf(): void
+    {
+        $this->assertEquals(null, $this->method->getReturnType());
+
+        $php7_method = new ReflectionMethod(new \ReflectionMethod(ReflectionReturnSelf::class, 'docBlock'));
+        $this->assertEquals(null, $php7_method->getReturnType());
     }
 }