Fix #329: Fix getting parameter types from the @method annotation

mspirkov · web-flow · commit 0ad57b615885 · 2025-11-17T00:59:34.000+03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,7 @@ Yii Framework 2 apidoc extension Change Log
 - Bug #324: Raise minimum PHP version to 7.4 (mspirkov)
 - Bug #325: Fix deprecation errors `The Default value will become of type Expression by default` (mspirkov)
 - Bug #327: Fix deprecation errors `The expression value will become of type Expression by default` (mspirkov)
+- Bug #329: Fix getting parameter types from the `@method` annotation (mspirkov)
 
 
 3.0.7 February 13, 2025
diff --git a/models/TypeDoc.php b/models/TypeDoc.php
@@ -231,7 +231,7 @@ public function __construct($reflector = null, $context = null, $config = [])
                         'name' => $parameter->getName(),
                         'typeHint' => $argumentType,
                         'type' => $argumentType,
-                        'types' => [],
+                        'types' => [$argumentType],
                     ]);
                 }
 
diff --git a/tests/commands/__snapshots__/ApiControllerTest__testGenerateBootstrap__1.html b/tests/commands/__snapshots__/ApiControllerTest__testGenerateBootstrap__1.html
@@ -437,11 +437,17 @@ <h2>Method Details</h2>
 
             <table class="detail-table table table-striped table-bordered table-hover">
                 <tr><td colspan="3" class="signature">
-<span class="signature-defs">public</span> <span class="signature-type"><a href="https://www.php.net/language.types.integer">integer</a></span> <strong><a href="yiiunit-apidoc-data-api-animal-animal.html#getSomething()-detail">getSomething</a></strong> ( <span style="color: #0000BB">$test</span> )</td></tr>
+<span class="signature-defs">public</span> <span class="signature-type"><a href="https://www.php.net/language.types.integer">integer</a></span> <strong><a href="yiiunit-apidoc-data-api-animal-animal.html#getSomething()-detail">getSomething</a></strong> ( <span style="color: #0000BB">$test</span>, <span class="signature-type"><a href="https://www.php.net/language.types.integer">integer</a></span> <span style="color: #0000BB">$test2</span> )</td></tr>
 
                                                             <tr>
                             <td class="param-name-col"><span style="color: #0000BB">$test</span></td>
-                            <td class="param-type-col"></td>
+                            <td class="param-type-col"><a href="https://www.php.net/language.types.mixed">mixed</a></td>
+                            <td class="param-desc-col">
+                                                           </td>
+                        </tr>
+                                            <tr>
+                            <td class="param-name-col"><span style="color: #0000BB">$test2</span></td>
+                            <td class="param-type-col"><a href="https://www.php.net/language.types.integer">integer</a></td>
                             <td class="param-desc-col">
                                                            </td>
                         </tr>
diff --git a/tests/commands/__snapshots__/ApiControllerTest__testGenerateBootstrap__2.html b/tests/commands/__snapshots__/ApiControllerTest__testGenerateBootstrap__2.html
@@ -323,11 +323,17 @@ <h2>Method Details</h2>
 
             <table class="detail-table table table-striped table-bordered table-hover">
                 <tr><td colspan="3" class="signature">
-<span class="signature-defs">public</span> <span class="signature-type"><a href="https://www.php.net/language.types.integer">integer</a></span> <strong><a href="yiiunit-apidoc-data-api-animal-animal.html#getSomething()-detail">getSomething</a></strong> ( <span style="color: #0000BB">$test</span> )</td></tr>
+<span class="signature-defs">public</span> <span class="signature-type"><a href="https://www.php.net/language.types.integer">integer</a></span> <strong><a href="yiiunit-apidoc-data-api-animal-animal.html#getSomething()-detail">getSomething</a></strong> ( <span style="color: #0000BB">$test</span>, <span class="signature-type"><a href="https://www.php.net/language.types.integer">integer</a></span> <span style="color: #0000BB">$test2</span> )</td></tr>
 
                                                             <tr>
                             <td class="param-name-col"><span style="color: #0000BB">$test</span></td>
-                            <td class="param-type-col"></td>
+                            <td class="param-type-col"><a href="https://www.php.net/language.types.mixed">mixed</a></td>
+                            <td class="param-desc-col">
+                                                           </td>
+                        </tr>
+                                            <tr>
+                            <td class="param-name-col"><span style="color: #0000BB">$test2</span></td>
+                            <td class="param-type-col"><a href="https://www.php.net/language.types.integer">integer</a></td>
                             <td class="param-desc-col">
                                                            </td>
                         </tr>
diff --git a/tests/commands/__snapshots__/ApiControllerTest__testGenerateBootstrap__3.html b/tests/commands/__snapshots__/ApiControllerTest__testGenerateBootstrap__3.html
@@ -318,11 +318,17 @@ <h2>Method Details</h2>
 
             <table class="detail-table table table-striped table-bordered table-hover">
                 <tr><td colspan="3" class="signature">
-<span class="signature-defs">public</span> <span class="signature-type"><a href="https://www.php.net/language.types.integer">integer</a></span> <strong><a href="yiiunit-apidoc-data-api-animal-animal.html#getSomething()-detail">getSomething</a></strong> ( <span style="color: #0000BB">$test</span> )</td></tr>
+<span class="signature-defs">public</span> <span class="signature-type"><a href="https://www.php.net/language.types.integer">integer</a></span> <strong><a href="yiiunit-apidoc-data-api-animal-animal.html#getSomething()-detail">getSomething</a></strong> ( <span style="color: #0000BB">$test</span>, <span class="signature-type"><a href="https://www.php.net/language.types.integer">integer</a></span> <span style="color: #0000BB">$test2</span> )</td></tr>
 
                                                             <tr>
                             <td class="param-name-col"><span style="color: #0000BB">$test</span></td>
-                            <td class="param-type-col"></td>
+                            <td class="param-type-col"><a href="https://www.php.net/language.types.mixed">mixed</a></td>
+                            <td class="param-desc-col">
+                                                           </td>
+                        </tr>
+                                            <tr>
+                            <td class="param-name-col"><span style="color: #0000BB">$test2</span></td>
+                            <td class="param-type-col"><a href="https://www.php.net/language.types.integer">integer</a></td>
                             <td class="param-desc-col">
                                                            </td>
                         </tr>
diff --git a/tests/data/api/animal/Animal.php b/tests/data/api/animal/Animal.php
@@ -14,7 +14,7 @@
  *
  * @property int $age animal age in seconds.
  *
- * @method int getSomething($test)
+ * @method int getSomething($test, int $test2)
  *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 1.0

Original file line number	Diff line number	Diff line change
`@@ -231,7 +231,7 @@ public function __construct($reflector = null, $context = null, $config = [])`
`231`	`231`	`'name' => $parameter->getName(),`
`232`	`232`	`'typeHint' => $argumentType,`
`233`	`233`	`'type' => $argumentType,`
`234`		`- 'types' => [],`
	`234`	`+ 'types' => [$argumentType],`
`235`	`235`	`]);`
`236`	`236`	`}`
`237`	`237`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`*`
`15`	`15`	`* @property int $age animal age in seconds.`
`16`	`16`	`*`
`17`		`- * @method int getSomething($test)`
	`17`	`+ * @method int getSomething($test, int $test2)`
`18`	`18`	`*`
`19`	`19`	`* @author Paul Klimov <[email protected]>`
`20`	`20`	`* @since 1.0`