Support variadic method param doc block - close #80

Author: sandrokeil

src/Code/DocBlock/Tag/ParamTag.php

@@ -20,11 +20,10 @@
  */
 final class ParamTag extends AbstractTypeableTag
 {
-    /**
-     * @var string
-     */
     protected string $variableName;
 
+    private bool $variadic = false;
+
     /**
      * ParamTag constructor.
      * @param string|null $variableName
@@ -67,14 +66,35 @@ public function getVariableName(): string
         return $this->variableName;
     }
 
+    /**
+     * @param bool $variadic
+     *
+     * @return ParamTag
+     */
+    public function setVariadic($variadic): self
+    {
+        $this->variadic = (bool) $variadic;
+
+        return $this;
+    }
+
+    /**
+     * @return bool
+     */
+    public function getVariadic(): bool
+    {
+        return $this->variadic;
+    }
+
     /**
      * @return string
      */
     public function generate(): string
     {
         $output = '@param'
             . (! empty($this->types) ? ' ' . $this->getTypesAsString() : '')
-            . (! empty($this->variableName) ? ' $' . $this->variableName : '')
+            . ($this->variadic ? ' ...' : ' ')
+            . (! empty($this->variableName) ? '$' . $this->variableName : '')
             . (! empty($this->description) ? ' ' . $this->description : '');
 
         return $output;

src/Code/MethodGenerator.php

@@ -265,7 +265,7 @@ private function generateAttributes(): array
                 if ($typeHint = $parameter->getTypeDocBlockHint()) {
                     $types = $typeHint;
                 }
-                $docBlock->addTag(new ParamTag($parameter->getName(), $types));
+                $docBlock->addTag((new ParamTag($parameter->getName(), $types))->setVariadic($parameter->getVariadic()));
             }
 
             $returnType = null;

tests/Code/MethodGeneratorTest.php

@@ -82,6 +82,46 @@ public function getItems() : array;
         $this->assertSame($expectedOutput, $this->printer->prettyPrintFile([$method->generate()]));
     }
 
+    /**
+     * @test
+     */
+    public function it_generates_method_with_variadic_doc_block(): void
+    {
+        $method = new MethodGenerator('setItems');
+        $method->setParameter((new ParameterGenerator('items'))->setVariadic(true)->setTypeDocBlockHint('mixed'));
+        $method->setReturnType('void');
+        $method->setDocBlockComment('');
+
+        $expectedOutput = <<<'EOF'
+        <?php
+        
+        /**
+         * @param mixed ...$items
+         */
+        public function setItems(...$items) : void;
+        EOF;
+
+        $this->assertSame($expectedOutput, $this->printer->prettyPrintFile([$method->generate()]));
+    }
+
+    /**
+     * @test
+     */
+    public function it_generates_method_with_mixed_variadic_without_doc_block(): void
+    {
+        $method = new MethodGenerator('setItems');
+        $method->setParameter((new ParameterGenerator('items'))->setVariadic(true)->setType('mixed'));
+        $method->setReturnType('void');
+
+        $expectedOutput = <<<'EOF'
+        <?php
+        
+        public function setItems(mixed ...$items) : void;
+        EOF;
+
+        $this->assertSame($expectedOutput, $this->printer->prettyPrintFile([$method->generate()]));
+    }
+
     /**
      * @test
      */