feature #22317 [Console] Make SymfonyQuestionHelper::ask optional by default (ro0NL)

fabpot · fabpot · commit b9cc0890c44d · 2017-07-20T19:25:39.000+02:00
This PR was merged into the 4.0-dev branch. Discussion ---------- [Console] Make SymfonyQuestionHelper::ask optional by default | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | yes | Tests pass? | yes (nothing in core depends on it) | Fixed tickets | #...  | License | MIT | Doc PR | symfony/symfony-docs#...  i noticed when writing commands i always keep doing ```php $io = new SymfonyStyle($input, $output); $answer = $io->ask('...', null, function ($value) { return $value; }); // instead of just $answer = $io->ask('...'); ``` only to bypass a built-in validation, of which im not sure why it's there. Note the base question helper doesnt make this assumption... Commits ------- 2da429c [Console] Make SymfonyQuestionHelper::ask optional by default
diff --git a/UPGRADE-3.3.md b/UPGRADE-3.3.md
@@ -72,6 +72,8 @@ Console
    have been deprecated in favor of the `console.error` event and the `ConsoleErrorEvent`
    class. The deprecated event and class will be removed in 4.0.
 
+ * The `SymfonyQuestionHelper::ask` default validation has been deprecated and will be removed in 4.0. Apply validation using `Question::setValidator` instead.
+
 Debug
 -----
 
diff --git a/UPGRADE-4.0.md b/UPGRADE-4.0.md
@@ -61,6 +61,8 @@ Console
  * The `console.exception` event and the related `ConsoleExceptionEvent` class have
    been removed in favor of the `console.error` event and the `ConsoleErrorEvent` class.
 
+ * The `SymfonyQuestionHelper::ask` default validation has been removed in favor of `Question::setValidator`.
+
 Debug
 -----
 
diff --git a/src/Symfony/Bundle/WebServerBundle/Command/ServerStartCommand.php b/src/Symfony/Bundle/WebServerBundle/Command/ServerStartCommand.php
@@ -94,7 +94,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
                 'You can either install it or use the "server:run" command instead.',
             ));
 
-            if ($io->ask('Do you want to execute <info>server:run</info> immediately? [yN] ', false)) {
+            if ($io->confirm('Do you want to execute <info>server:run</info> immediately?', false)) {
                 return $this->getApplication()->find('server:run')->run($input, $output);
             }
 
diff --git a/src/Symfony/Component/Console/CHANGELOG.md b/src/Symfony/Component/Console/CHANGELOG.md
@@ -27,6 +27,7 @@ CHANGELOG
 * deprecated console.exception event in favor of console.error
 * added ability to handle `CommandNotFoundException` through the 
  `console.error` event
+* deprecated default validation in `SymfonyQuestionHelper::ask`
 
 3.2.0
 ------
diff --git a/src/Symfony/Component/Console/Helper/SymfonyQuestionHelper.php b/src/Symfony/Component/Console/Helper/SymfonyQuestionHelper.php
@@ -29,6 +29,8 @@ class SymfonyQuestionHelper extends QuestionHelper
 {
     /**
      * {@inheritdoc}
+     *
+     * To be removed in 4.0
      */
     public function ask(InputInterface $input, OutputInterface $output, Question $question)
     {
@@ -39,6 +41,8 @@ public function ask(InputInterface $input, OutputInterface $output, Question $qu
             } else {
                 // make required
                 if (!is_array($value) && !is_bool($value) && 0 === strlen($value)) {
+                    @trigger_error('The default question validator is deprecated since Symfony 3.3 and will not be used anymore in version 4.0. Set a custom question validator if needed.', E_USER_DEPRECATED);
+
                     throw new LogicException('A value is required.');
                 }
             }

Original file line number	Diff line number	Diff line change
`@@ -94,7 +94,7 @@ protected function execute(InputInterface $input, OutputInterface $output)`
`94`	`94`	`'You can either install it or use the "server:run" command instead.',`
`95`	`95`	`));`
`96`	`96`
`97`		`- if ($io->ask('Do you want to execute <info>server:run</info> immediately? [yN] ', false)) {`
	`97`	`+ if ($io->confirm('Do you want to execute <info>server:run</info> immediately?', false)) {`
`98`	`98`	`return $this->getApplication()->find('server:run')->run($input, $output);`
`99`	`99`	`}`
`100`	`100`
Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,8 @@ class SymfonyQuestionHelper extends QuestionHelper`
`29`	`29`	`{`
`30`	`30`	`/**`
`31`	`31`	`* {@inheritdoc}`
	`32`	`+ *`
	`33`	`+ * To be removed in 4.0`
`32`	`34`	`*/`
`33`	`35`	`public function ask(InputInterface $input, OutputInterface $output, Question $question)`
`34`	`36`	`{`
`@@ -39,6 +41,8 @@ public function ask(InputInterface $input, OutputInterface $output, Question $qu`
`39`	`41`	`} else {`
`40`	`42`	`// make required`
`41`	`43`	`if (!is_array($value) && !is_bool($value) && 0 === strlen($value)) {`
	`44`	`+ @trigger_error('The default question validator is deprecated since Symfony 3.3 and will not be used anymore in version 4.0. Set a custom question validator if needed.', E_USER_DEPRECATED);`
	`45`	`+`
`42`	`46`	`throw new LogicException('A value is required.');`
`43`	`47`	`}`
`44`	`48`	`}`