minor #25644 [Console] Improve phpdoc on StyleInterface::ask() (ro0NL)

This PR was merged into the 2.7 branch.

Discussion
----------

[Console] Improve phpdoc on StyleInterface::ask()

| Q             | A
| ------------- | ---
| Branch?       | 2.7
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #... <!-- #-prefixed issue number(s), if any -->
| License       | MIT
| Doc PR        | symfony/symfony-docs#... <!--highly recommended for new features-->

In a CLI command i keep asking an optional question until i get an answer. So interactively it's a required question. It looks like..

```php
do {
    $value = $io->ask('Value', null, function ($value) { return $value; });
} while (null === $value);
```

Which works nice.. but SA is complaining about

```
Strict comparison using === between null and string will always evaluate to false.
```

This should fix it. The mixed API goes back to https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Console/Helper/QuestionHelper.php#L38

Commits
-------

499d04f [Console] Improve phpdoc on StyleInterface::ask()
This commit is contained in:
Nicolas Grekas 2018-01-16 19:55:58 +01:00
commit 30086cc65b
2 changed files with 4 additions and 4 deletions

View File

@ -91,7 +91,7 @@ interface StyleInterface
* @param string|null $default
* @param callable|null $validator
*
* @return string
* @return mixed
*/
public function ask($question, $default = null, $validator = null);
@ -101,7 +101,7 @@ interface StyleInterface
* @param string $question
* @param callable|null $validator
*
* @return string
* @return mixed
*/
public function askHidden($question, $validator = null);
@ -122,7 +122,7 @@ interface StyleInterface
* @param array $choices
* @param string|int|null $default
*
* @return string
* @return mixed
*/
public function choice($question, array $choices, $default = null);

View File

@ -314,7 +314,7 @@ class SymfonyStyle extends OutputStyle
}
/**
* @return string
* @return mixed
*/
public function askQuestion(Question $question)
{