[GenerateMarkdownDoc] Don't crash if method uses union type parameter (…

…#1118)
consolidation · Aug 21, 2022 · 3ecd1db · 3ecd1db
1 parent d380673
commit 3ecd1db
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 5 deletions.
diff --git a/src/Task/Development/GenerateMarkdownDoc.php b/src/Task/Development/GenerateMarkdownDoc.php
@@ -674,11 +674,13 @@ protected function documentParam(\ReflectionParameter $param)
     {
         $text = "";
         $paramType = $param->getType();
-        if (($paramType != null) && ($paramType->getName() == 'array')) {
-            $text .= 'array ';
-        }
-        if (($paramType != null) && ($paramType->getName() == 'callable')) {
-            $text .= 'callable ';
+        if ($paramType instanceof \ReflectionNamedType) {
+            if ($paramType->getName() === 'array') {
+                $text .= 'array ';
+            }
+            if (($paramType->getName() === 'callable')) {
+                $text .= 'callable ';
+            }
         }
         $text .= '$' . $param->name;
         if ($param->isDefaultValueAvailable()) {

diff --git a/tests/_data/ClassWithUnionParam.php b/tests/_data/ClassWithUnionParam.php
@@ -0,0 +1,14 @@
+<?php
+
+use Robo\Result;
+
+/**
+ * A test file. Used for testing documentation generation.
+ */
+class ClassWithUnionParam
+{
+    final public static function executeTask(Robo\Task\Composer\Install|Robo\Task\Composer\Update $task): string|array
+    {
+        return [];
+    }
+}
diff --git a/tests/integration/GenerateMarkdownDocTest.php b/tests/integration/GenerateMarkdownDocTest.php
@@ -97,4 +97,27 @@ function (\ReflectionMethod $m, $text) {
         $this->assertStringContainsString('Set the destination file', $contents);
     }
 
+    public function testMarkdownOfUnionType()
+    {
+        if (version_compare(PHP_VERSION, '8.0') < 0) {
+            $this->markTestSkipped('Requires PHP 8.0');
+        }
+
+        $sourceFile = $this->fixtures->dataFile('ClassWithUnionParam.php');
+        $this->assertFileExists($sourceFile);
+        include $sourceFile;
+        $this->assertTrue(class_exists('ClassWithUnionParam'));
+
+        $collection = $this->collectionBuilderForTest();
+        $taskGenerator = $collection->taskGenDoc("ClassWithUnionParam.md");
+        $taskGenerator->docClass('ClassWithUnionParam');
+        $result = $collection->run();
+        $this->assertTrue($result->wasSuccessful(), $result->getMessage());
+
+        $this->assertFileExists('ClassWithUnionParam.md');
+
+        $contents = file_get_contents('ClassWithUnionParam.md');
+        $this->assertStringContainsString('A test file. Used for testing documentation generation.', $contents);
+        $this->assertStringContainsString('#### *final public static* executeTask($task)', $contents);
+    }
 }