Fixes #10372: Fixed console controller including complex typed argume…

…nts in help
yiisoft · Mar 15, 2017 · 9459eaa · 9459eaa
1 parent 8192f84
commit 9459eaa
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 1 deletion.
diff --git a/framework/CHANGELOG.md b/framework/CHANGELOG.md
@@ -46,7 +46,7 @@ Yii Framework 2 Change Log
 - Enh #13695: `\yii\web\Response::setStatusCode()` method now returns the Response object itself (kyle-mccarthy)
 - Enh #13698: `yii\grid\DataColumn` filter is automatically generated as dropdown list in case of `format` set to `boolean` (bizley)
 - Enh #13254: Core validators no longer require Yii::$app to be set (sammousa)
-
+- Bug #10372: Fixed console controller including complex typed arguments in help (sammousa)
 
 2.0.11.2 February 08, 2017
 --------------------------

diff --git a/framework/console/Controller.php b/framework/console/Controller.php
@@ -467,6 +467,9 @@ public function getActionArgsHelp($action)
 
         /** @var \ReflectionParameter $reflection */
         foreach ($method->getParameters() as $i => $reflection) {
+            if ($reflection->getClass() !== null) {
+                continue;
+            }
             $name = $reflection->getName();
             $tag = isset($params[$i]) ? $params[$i] : '';
             if (preg_match('/^(\S+)\s+(\$\w+\s+)?(.*)/s', $tag, $matches)) {

diff --git a/tests/framework/console/ControllerTest.php b/tests/framework/console/ControllerTest.php
@@ -132,4 +132,18 @@ public function testHelpOptionWithModule()
         $this->assertFalse(FakeController::getWasActionIndexCalled());
         $this->assertEquals(FakeHelpController::getActionIndexLastCallParams(), ['news/posts/index']);
     }
+
+
+    /**
+     * Tests if action help does not include (class) type hinted arguments.
+     * @see #10372
+     */
+    public function testHelpSkipsTypeHintedArguments()
+     {
+         $controller = new FakeController('fake', Yii::$app);
+         $help = $controller->getActionArgsHelp($controller->createAction('with-complex-type-hint'));
+
+         $this->assertArrayNotHasKey('typedArgument', $help);
+         $this->assertArrayHasKey('simpleArgument', $help);
+     }
 }
diff --git a/tests/framework/console/FakeController.php b/tests/framework/console/FakeController.php
@@ -84,6 +84,10 @@ public function actionAksi6()
         return $this->testArray;
     }
 
+    public function actionWithComplexTypeHint(self $typedArgument, $simpleArgument) {
+        return $simpleArgument;
+    }
+
     public function actionStatus($status = 0)
     {
         return $status;