minor symfony#21028 [Console] Updated phpdoc on return types (mlpo)

fabpot · fabpot · commit be691d5e7050 · 2017-02-14T19:34:00.000+01:00
This PR was merged into the 2.7 branch. Discussion ---------- [Console] Updated phpdoc on return types | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a The return type of “ask” is not necessarily a string (notice that “doAsk” may return mixed type). Same for “validateAttempts” (validator may return something else than a string). Commits ------- 442a304 [Console] Updated phpdoc on return types
diff --git a/src/Symfony/Component/Console/Helper/QuestionHelper.php b/src/Symfony/Component/Console/Helper/QuestionHelper.php
@@ -37,7 +37,7 @@ class QuestionHelper extends Helper
      * @param OutputInterface $output   An OutputInterface instance
      * @param Question        $question The question to ask
      *
-     * @return string The user answer
+     * @return mixed The user answer
      *
      * @throws \RuntimeException If there is no data to read in the input stream
      */
@@ -383,7 +383,7 @@ private function getHiddenResponse(OutputInterface $output, $inputStream)
      * @param OutputInterface $output      An Output instance
      * @param Question        $question    A Question instance
      *
-     * @return string The validated response
+     * @return mixed The validated response
      *
      * @throws \Exception In case the max number of attempts has been reached and no valid response has been given
      */

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ class QuestionHelper extends Helper`
`37`	`37`	`* @param OutputInterface $output An OutputInterface instance`
`38`	`38`	`* @param Question $question The question to ask`
`39`	`39`	`*`
`40`		`- * @return string The user answer`
	`40`	`+ * @return mixed The user answer`
`41`	`41`	`*`
`42`	`42`	`* @throws \RuntimeException If there is no data to read in the input stream`
`43`	`43`	`*/`
`@@ -383,7 +383,7 @@ private function getHiddenResponse(OutputInterface $output, $inputStream)`
`383`	`383`	`* @param OutputInterface $output An Output instance`
`384`	`384`	`* @param Question $question A Question instance`
`385`	`385`	`*`
`386`		`- * @return string The validated response`
	`386`	`+ * @return mixed The validated response`
`387`	`387`	`*`
`388`	`388`	`* @throws \Exception In case the max number of attempts has been reached and no valid response has been given`
`389`	`389`	`*/`