Fix #313: Fix deprecation error Method deprecated, use ::getParameters()

mspirkov · web-flow · commit b9550d89d09a · 2025-11-10T17:15:39.000+03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,7 @@ Yii Framework 2 apidoc extension Change Log
 3.0.8 under development
 -----------------------
 
-- Bug #314: Fix deprecation error `Method deprecated, use ::getParameters()` (mspirkov)
+- Bug #313: Fix deprecation error `Method deprecated, use ::getParameters()` (mspirkov)
 
 
 3.0.7 February 13, 2025
diff --git a/models/TypeDoc.php b/models/TypeDoc.php
@@ -223,19 +223,33 @@ public function __construct($reflector = null, $context = null, $config = [])
             if ($tag instanceof Method) {
                 $params = [];
 
-                foreach ($tag->getParameters() as $parameter) {
-                    $argumentType = (string) $parameter->getType();
-
-                    $params[] = new ParamDoc(null, $context, [
-                        'sourceFile' => $this->sourceFile,
-                        'name' => $parameter->getName(),
-                        'typeHint' => $argumentType,
-                        'type' => $argumentType,
-                        'types' => [],
-                    ]);
+                if (PHP_VERSION_ID >= 70400) {
+                    foreach ($tag->getParameters() as $parameter) {
+                        $argumentType = (string) $parameter->getType();
+
+                        $params[] = new ParamDoc(null, $context, [
+                            'sourceFile' => $this->sourceFile,
+                            'name' => $parameter->getName(),
+                            'typeHint' => $argumentType,
+                            'type' => $argumentType,
+                            'types' => [],
+                        ]);
+                    }
+                } else {
+                  foreach ($tag->getArguments() as $parameter) {
+                        $argumentType = (string) $parameter['type'];
+
+                        $params[] = new ParamDoc(null, $context, [
+                            'sourceFile' => $this->sourceFile,
+                            'name' => $parameter['name'],
+                            'typeHint' => $argumentType,
+                            'type' => $argumentType,
+                            'types' => [],
+                        ]);
+                    }
                 }
 
-                $shortDescription = $tag->getDescription() ? BaseDoc::extractFirstSentence($tag->getDescription()): '';
+                $shortDescription = $tag->getDescription() ? BaseDoc::extractFirstSentence($tag->getDescription()) : '';
                 $description = $shortDescription ? substr($tag->getDescription(), strlen($shortDescription)) : '';
 
                 $method = new MethodDoc(null, $context, [
diff --git a/tests/commands/ApiControllerTest.php b/tests/commands/ApiControllerTest.php
@@ -77,6 +77,25 @@ public function testGenerateBootstrap()
         $this->assertStringContainsString('Animal is a base class for animals.', $animalContent);
         $this->assertContainsWithoutIndent(
             <<<HTML
+    <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>
+<tr>
+    <td class="param-name-col"><span style="color: #0000BB">\$test</span></td>
+    <td class="param-type-col"></td>
+    <td class="param-desc-col">   </td>
+</tr>
+<tr>
+    <th class="param-name-col">return</th>
+    <td class="param-type-col"><a href="https://www.php.net/language.types.integer">integer</a></td>
+    <td class="param-desc-col"></td>
+</tr>
+HTML
+            , $animalContent
+        );
+        $this->assertContainsWithoutIndent(
+            <<<HTML
 <tr id="\$name" class="">
     <td><a href="yiiunit-apidoc-data-api-animal-animal.html#\$name-detail">\$name</a></td>
     <td><a href="https://www.php.net/language.types.string">string</a></td>
diff --git a/tests/data/api/animal/Animal.php b/tests/data/api/animal/Animal.php
@@ -14,6 +14,8 @@
  *
  * @property int $age animal age in seconds.
  *
+ * @method int getSomething($test)
+ *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 1.0
  */

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,8 @@`
`14`	`14`	`*`
`15`	`15`	`* @property int $age animal age in seconds.`
`16`	`16`	`*`
	`17`	`+ * @method int getSomething($test)`
	`18`	`+ *`
`17`	`19`	`* @author Paul Klimov <[email protected]>`
`18`	`20`	`* @since 1.0`
`19`	`21`	`*/`