[Console] Added return types

wouterj · wouterj · commit 0fff9573d9f5 · 2020-11-21T17:47:51.000+01:00
diff --git a/console.rst b/console.rst
@@ -38,12 +38,12 @@ want a command to create a user::
         // the name of the command (the part after "bin/console")
         protected static $defaultName = 'app:create-user';
 
-        protected function configure()
+        protected function configure(): void
         {
             // ...
         }
 
-        protected function execute(InputInterface $input, OutputInterface $output)
+        protected function execute(InputInterface $input, OutputInterface $output): int
         {
             // ...
 
@@ -58,7 +58,7 @@ You can optionally define a description, help message and the
 :doc:`input options and arguments </console/input>`::
 
     // ...
-    protected function configure()
+    protected function configure(): void
     {
         $this
             // the short description shown while running "php bin/console list"
@@ -93,7 +93,7 @@ available in the ``configure()`` method::
             parent::__construct();
         }
 
-        protected function configure()
+        protected function configure(): void
         {
             $this
                 // ...
@@ -129,7 +129,7 @@ The ``execute()`` method has access to the output stream to write messages to
 the console::
 
     // ...
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         // outputs multiple lines to the console (adding "\n" at the end of each line)
         $output->writeln([
@@ -179,7 +179,7 @@ which returns an instance of
 
     class MyCommand extends Command
     {
-        protected function execute(InputInterface $input, OutputInterface $output)
+        protected function execute(InputInterface $input, OutputInterface $output): int
         {
             $section1 = $output->section();
             $section2 = $output->section();
@@ -221,7 +221,7 @@ Use input options or arguments to pass information to the command::
     use Symfony\Component\Console\Input\InputArgument;
 
     // ...
-    protected function configure()
+    protected function configure(): void
     {
         $this
             // configure an argument
@@ -231,7 +231,7 @@ Use input options or arguments to pass information to the command::
     }
 
     // ...
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         $output->writeln([
             'User Creator',
@@ -285,7 +285,7 @@ as a service, you can use normal dependency injection. Imagine you have a
 
         // ...
 
-        protected function execute(InputInterface $input, OutputInterface $output)
+        protected function execute(InputInterface $input, OutputInterface $output): int
         {
             // ...
 
diff --git a/console/calling_commands.rst b/console/calling_commands.rst
@@ -8,26 +8,32 @@ or if you want to create a "meta" command that runs a bunch of other commands
 changed on the production servers: clearing the cache, generating Doctrine
 proxies, dumping web assets, ...).
 
-Calling a command from another one is straightforward::
+.. code-block:: php
 
+    // ...
+    use Symfony\Component\Console\Command;
     use Symfony\Component\Console\Input\ArrayInput;
     use Symfony\Component\Console\Input\InputInterface;
     use Symfony\Component\Console\Output\OutputInterface;
-    // ...
 
-    protected function execute(InputInterface $input, OutputInterface $output)
+    class CreateUserCommand extends Command
     {
-        $command = $this->getApplication()->find('demo:greet');
+        // ...
 
-        $arguments = [
-            'name'    => 'Fabien',
-            '--yell'  => true,
-        ];
+        protected function execute(InputInterface $input, OutputInterface $output): void
+        {
+            $command = $this->getApplication()->find('demo:greet');
 
-        $greetInput = new ArrayInput($arguments);
-        $returnCode = $command->run($greetInput, $output);
+            $arguments = [
+                'name'    => 'Fabien',
+                '--yell'  => true,
+            ];
 
-        // ...
+            $greetInput = new ArrayInput($arguments);
+            $returnCode = $command->run($greetInput, $output);
+
+            // ...
+        }
     }
 
 First, you :method:`Symfony\\Component\\Console\\Application::find` the
diff --git a/console/command_in_controller.rst b/console/command_in_controller.rst
@@ -36,7 +36,7 @@ Run this command from inside your controller via::
 
     class SpoolController extends AbstractController
     {
-        public function sendSpool($messages = 10, KernelInterface $kernel)
+        public function sendSpool(int $messages = 10, KernelInterface $kernel): Response
         {
             $application = new Application($kernel);
             $application->setAutoExit(false);
@@ -87,7 +87,7 @@ Now, use it in your controller::
 
     class SpoolController extends AbstractController
     {
-        public function sendSpool($messages = 10)
+        public function sendSpool(int $messages = 10): Response
         {
             // ...
             $output = new BufferedOutput(
diff --git a/console/commands_as_services.rst b/console/commands_as_services.rst
@@ -35,17 +35,17 @@ For example, suppose you want to log something from within your command::
             parent::__construct();
         }
 
-        protected function configure()
+        protected function configure(): void
         {
             $this
                 ->setDescription('Good morning!');
         }
 
-        protected function execute(InputInterface $input, OutputInterface $output)
+        protected function execute(InputInterface $input, OutputInterface $output): int
         {
             $this->logger->info('Waking up the sun');
             // ...
-            
+
             return 0;
         }
     }
diff --git a/console/hide_commands.rst b/console/hide_commands.rst
@@ -20,7 +20,7 @@ In those cases, you can define the command as **hidden** by setting the
     {
         protected static $defaultName = 'app:legacy';
 
-        protected function configure()
+        protected function configure(): void
         {
             $this
                 ->setHidden(true)
diff --git a/console/input.rst b/console/input.rst
@@ -21,7 +21,7 @@ and make the ``name`` argument required::
     {
         // ...
 
-        protected function configure()
+        protected function configure(): void
         {
             $this
                 // ...
@@ -42,7 +42,7 @@ You now have access to a ``last_name`` argument in your command::
     {
         // ...
 
-        protected function execute(InputInterface $input, OutputInterface $output)
+        protected function execute(InputInterface $input, OutputInterface $output): int
         {
             $text = 'Hi '.$input->getArgument('name');
 
@@ -52,6 +52,8 @@ You now have access to a ``last_name`` argument in your command::
             }
 
             $output->writeln($text.'!');
+
+            return 0;
         }
     }
 
diff --git a/console/lockable_trait.rst b/console/lockable_trait.rst
@@ -22,7 +22,7 @@ that adds two convenient methods to lock and release commands::
 
         // ...
 
-        protected function execute(InputInterface $input, OutputInterface $output)
+        protected function execute(InputInterface $input, OutputInterface $output): int
         {
             if (!$this->lock()) {
                 $output->writeln('The command is already running in another process.');
@@ -38,6 +38,8 @@ that adds two convenient methods to lock and release commands::
             // if not released explicitly, Symfony releases the lock
             // automatically when the execution of the command ends
             $this->release();
+
+            return 0;
         }
     }
 
diff --git a/console/style.rst b/console/style.rst
@@ -21,7 +21,7 @@ Consider for example the code used to display the title of the following command
     {
         // ...
 
-        protected function execute(InputInterface $input, OutputInterface $output)
+        protected function execute(InputInterface $input, OutputInterface $output): int
         {
             $output->writeln([
                 '<info>Lorem Ipsum Dolor Sit Amet</>',
@@ -62,7 +62,7 @@ title of the command::
     {
         // ...
 
-        protected function execute(InputInterface $input, OutputInterface $output)
+        protected function execute(InputInterface $input, OutputInterface $output): int
         {
             $io = new SymfonyStyle($input, $output);
             $io->title('Lorem Ipsum Dolor Sit Amet');
@@ -399,7 +399,7 @@ of your commands to change their appearance::
     {
         // ...
 
-        protected function execute(InputInterface $input, OutputInterface $output)
+        protected function execute(InputInterface $input, OutputInterface $output): int
         {
             // Before
             $io = new SymfonyStyle($input, $output);
diff --git a/console/verbosity.rst b/console/verbosity.rst
@@ -49,7 +49,7 @@ level. For example::
     {
         // ...
 
-        public function execute(InputInterface $input, OutputInterface $output)
+        public function execute(InputInterface $input, OutputInterface $output): int
         {
             $user = new User(...);
 
@@ -68,6 +68,8 @@ level. For example::
                 'Will only be printed in verbose mode or higher',
                 OutputInterface::VERBOSITY_VERBOSE
             );
+
+            return 0;
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -38,12 +38,12 @@ want a command to create a user::`
`38`	`38`	`// the name of the command (the part after "bin/console")`
`39`	`39`	`protected static $defaultName = 'app:create-user';`
`40`	`40`
`41`		`- protected function configure()`
	`41`	`+ protected function configure(): void`
`42`	`42`	`{`
`43`	`43`	`// ...`
`44`	`44`	`}`
`45`	`45`
`46`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`46`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`47`	`47`	`{`
`48`	`48`	`// ...`
`49`	`49`
`@@ -58,7 +58,7 @@ You can optionally define a description, help message and the`
`58`	`58`	:doc:`input options and arguments </console/input>`::
`59`	`59`
`60`	`60`	`// ...`
`61`		`- protected function configure()`
	`61`	`+ protected function configure(): void`
`62`	`62`	`{`
`63`	`63`	`$this`
`64`	`64`	`// the short description shown while running "php bin/console list"`
@@ -93,7 +93,7 @@ available in the ``configure()`` method::
`93`	`93`	`parent::__construct();`
`94`	`94`	`}`
`95`	`95`
`96`		`- protected function configure()`
	`96`	`+ protected function configure(): void`
`97`	`97`	`{`
`98`	`98`	`$this`
`99`	`99`	`// ...`
@@ -129,7 +129,7 @@ The ``execute()`` method has access to the output stream to write messages to
`129`	`129`	`the console::`
`130`	`130`
`131`	`131`	`// ...`
`132`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`132`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`133`	`133`	`{`
`134`	`134`	`// outputs multiple lines to the console (adding "\n" at the end of each line)`
`135`	`135`	`$output->writeln([`
`@@ -179,7 +179,7 @@ which returns an instance of`
`179`	`179`
`180`	`180`	`class MyCommand extends Command`
`181`	`181`	`{`
`182`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`182`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`183`	`183`	`{`
`184`	`184`	`$section1 = $output->section();`
`185`	`185`	`$section2 = $output->section();`
`@@ -221,7 +221,7 @@ Use input options or arguments to pass information to the command::`
`221`	`221`	`use Symfony\Component\Console\Input\InputArgument;`
`222`	`222`
`223`	`223`	`// ...`
`224`		`- protected function configure()`
	`224`	`+ protected function configure(): void`
`225`	`225`	`{`
`226`	`226`	`$this`
`227`	`227`	`// configure an argument`
`@@ -231,7 +231,7 @@ Use input options or arguments to pass information to the command::`
`231`	`231`	`}`
`232`	`232`
`233`	`233`	`// ...`
`234`		`- public function execute(InputInterface $input, OutputInterface $output)`
	`234`	`+ public function execute(InputInterface $input, OutputInterface $output): int`
`235`	`235`	`{`
`236`	`236`	`$output->writeln([`
`237`	`237`	`'User Creator',`
`@@ -285,7 +285,7 @@ as a service, you can use normal dependency injection. Imagine you have a`
`285`	`285`
`286`	`286`	`// ...`
`287`	`287`
`288`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`288`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`289`	`289`	`{`
`290`	`290`	`// ...`
`291`	`291`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ Run this command from inside your controller via::`
`36`	`36`
`37`	`37`	`class SpoolController extends AbstractController`
`38`	`38`	`{`
`39`		`- public function sendSpool($messages = 10, KernelInterface $kernel)`
	`39`	`+ public function sendSpool(int $messages = 10, KernelInterface $kernel): Response`
`40`	`40`	`{`
`41`	`41`	`$application = new Application($kernel);`
`42`	`42`	`$application->setAutoExit(false);`
`@@ -87,7 +87,7 @@ Now, use it in your controller::`
`87`	`87`
`88`	`88`	`class SpoolController extends AbstractController`
`89`	`89`	`{`
`90`		`- public function sendSpool($messages = 10)`
	`90`	`+ public function sendSpool(int $messages = 10): Response`
`91`	`91`	`{`
`92`	`92`	`// ...`
`93`	`93`	`$output = new BufferedOutput(`
Original file line number	Diff line number	Diff line change
`@@ -35,17 +35,17 @@ For example, suppose you want to log something from within your command::`
`35`	`35`	`parent::__construct();`
`36`	`36`	`}`
`37`	`37`
`38`		`- protected function configure()`
	`38`	`+ protected function configure(): void`
`39`	`39`	`{`
`40`	`40`	`$this`
`41`	`41`	`->setDescription('Good morning!');`
`42`	`42`	`}`
`43`	`43`
`44`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`44`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`45`	`45`	`{`
`46`	`46`	`$this->logger->info('Waking up the sun');`
`47`	`47`	`// ...`
`48`		`-`
	`48`	`+`
`49`	`49`	`return 0;`
`50`	`50`	`}`
`51`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ In those cases, you can define the command as hidden by setting the`
`20`	`20`	`{`
`21`	`21`	`protected static $defaultName = 'app:legacy';`
`22`	`22`
`23`		`- protected function configure()`
	`23`	`+ protected function configure(): void`
`24`	`24`	`{`
`25`	`25`	`$this`
`26`	`26`	`->setHidden(true)`
Original file line number	Diff line number	Diff line change
@@ -21,7 +21,7 @@ and make the ``name`` argument required::
`21`	`21`	`{`
`22`	`22`	`// ...`
`23`	`23`
`24`		`- protected function configure()`
	`24`	`+ protected function configure(): void`
`25`	`25`	`{`
`26`	`26`	`$this`
`27`	`27`	`// ...`
@@ -42,7 +42,7 @@ You now have access to a ``last_name`` argument in your command::
`42`	`42`	`{`
`43`	`43`	`// ...`
`44`	`44`
`45`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`45`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`46`	`46`	`{`
`47`	`47`	`$text = 'Hi '.$input->getArgument('name');`
`48`	`48`
@@ -52,6 +52,8 @@ You now have access to a ``last_name`` argument in your command::
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`$output->writeln($text.'!');`
	`55`	`+`
	`56`	`+ return 0;`
`55`	`57`	`}`
`56`	`58`	`}`
`57`	`59`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ that adds two convenient methods to lock and release commands::`
`22`	`22`
`23`	`23`	`// ...`
`24`	`24`
`25`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`25`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`26`	`26`	`{`
`27`	`27`	`if (!$this->lock()) {`
`28`	`28`	`$output->writeln('The command is already running in another process.');`
`@@ -38,6 +38,8 @@ that adds two convenient methods to lock and release commands::`
`38`	`38`	`// if not released explicitly, Symfony releases the lock`
`39`	`39`	`// automatically when the execution of the command ends`
`40`	`40`	`$this->release();`
	`41`	`+`
	`42`	`+ return 0;`
`41`	`43`	`}`
`42`	`44`	`}`
`43`	`45`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ Consider for example the code used to display the title of the following command`
`21`	`21`	`{`
`22`	`22`	`// ...`
`23`	`23`
`24`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`24`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`25`	`25`	`{`
`26`	`26`	`$output->writeln([`
`27`	`27`	`'<info>Lorem Ipsum Dolor Sit Amet</>',`
`@@ -62,7 +62,7 @@ title of the command::`
`62`	`62`	`{`
`63`	`63`	`// ...`
`64`	`64`
`65`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`65`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`66`	`66`	`{`
`67`	`67`	`$io = new SymfonyStyle($input, $output);`
`68`	`68`	`$io->title('Lorem Ipsum Dolor Sit Amet');`
`@@ -399,7 +399,7 @@ of your commands to change their appearance::`
`399`	`399`	`{`
`400`	`400`	`// ...`
`401`	`401`
`402`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`402`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`403`	`403`	`{`
`404`	`404`	`// Before`
`405`	`405`	`$io = new SymfonyStyle($input, $output);`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ level. For example::`
`49`	`49`	`{`
`50`	`50`	`// ...`
`51`	`51`
`52`		`- public function execute(InputInterface $input, OutputInterface $output)`
	`52`	`+ public function execute(InputInterface $input, OutputInterface $output): int`
`53`	`53`	`{`
`54`	`54`	`$user = new User(...);`
`55`	`55`
`@@ -68,6 +68,8 @@ level. For example::`
`68`	`68`	`'Will only be printed in verbose mode or higher',`
`69`	`69`	`OutputInterface::VERBOSITY_VERBOSE`
`70`	`70`	`);`
	`71`	`+`
	`72`	`+ return 0;`
`71`	`73`	`}`
`72`	`74`	`}`
`73`	`75`