[Console] Command::execute() should always return int - deprecate returning null

jschaedl · nicolas-grekas · commit 38fc5d8a95b4 · 2019-10-02T16:44:58.000+02:00
- added deprecation message for non-int return value in Command::execute()
- fixed all core commands to return proper int values
- added proper return type-hint to Command::execute() method in all core Commands
diff --git a/Command/AboutCommand.php b/Command/AboutCommand.php
@@ -54,7 +54,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
 
@@ -100,6 +100,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
         }
 
         $io->table([], $rows);
+
+        return 0;
     }
 
     private static function formatPath(string $path, string $baseDir): string
diff --git a/Command/CacheClearCommand.php b/Command/CacheClearCommand.php
@@ -72,7 +72,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $fs = $this->filesystem;
         $io = new SymfonyStyle($input, $output);
@@ -175,6 +175,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
         }
 
         $io->success(sprintf('Cache for the "%s" environment (debug=%s) was successfully cleared.', $kernel->getEnvironment(), var_export($kernel->isDebug(), true)));
+
+        return 0;
     }
 
     private function warmup(string $warmupDir, string $realCacheDir, bool $enableOptionalWarmers = true)
diff --git a/Command/CachePoolClearCommand.php b/Command/CachePoolClearCommand.php
@@ -60,7 +60,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
         $kernel = $this->getApplication()->getKernel();
@@ -99,5 +99,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         }
 
         $io->success('Cache was successfully cleared.');
+
+        return 0;
     }
 }
diff --git a/Command/CachePoolDeleteCommand.php b/Command/CachePoolDeleteCommand.php
@@ -59,7 +59,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
         $pool = $input->getArgument('pool');
@@ -69,13 +69,15 @@ protected function execute(InputInterface $input, OutputInterface $output)
         if (!$cachePool->hasItem($key)) {
             $io->note(sprintf('Cache item "%s" does not exist in cache pool "%s".', $key, $pool));
 
-            return;
+            return 0;
         }
 
         if (!$cachePool->deleteItem($key)) {
             throw new \Exception(sprintf('Cache item "%s" could not be deleted.', $key));
         }
 
         $io->success(sprintf('Cache item "%s" was successfully deleted.', $key));
+
+        return 0;
     }
 }
diff --git a/Command/CachePoolListCommand.php b/Command/CachePoolListCommand.php
@@ -51,12 +51,14 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
 
         $io->table(['Pool name'], array_map(function ($pool) {
             return [$pool];
         }, $this->poolNames));
+
+        return 0;
     }
 }
diff --git a/Command/CachePoolPruneCommand.php b/Command/CachePoolPruneCommand.php
@@ -57,7 +57,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
 
@@ -67,5 +67,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         }
 
         $io->success('Successfully pruned cache pool(s).');
+
+        return 0;
     }
 }
diff --git a/Command/CacheWarmupCommand.php b/Command/CacheWarmupCommand.php
@@ -66,7 +66,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
 
@@ -80,5 +80,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $this->cacheWarmer->warmUp($kernel->getContainer()->getParameter('kernel.cache_dir'));
 
         $io->success(sprintf('Cache for the "%s" environment (debug=%s) was successfully warmed.', $kernel->getEnvironment(), var_export($kernel->isDebug(), true)));
+
+        return 0;
     }
 }
diff --git a/Command/ConfigDebugCommand.php b/Command/ConfigDebugCommand.php
@@ -63,7 +63,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
         $errorIo = $io->getErrorStyle();
@@ -73,7 +73,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $errorIo->comment('Provide the name of a bundle as the first argument of this command to dump its configuration. (e.g. <comment>debug:config FrameworkBundle</comment>)');
             $errorIo->comment('For dumping a specific option, add its path as the second argument of this command. (e.g. <comment>debug:config FrameworkBundle serializer</comment> to dump the <comment>framework.serializer</comment> configuration)');
 
-            return;
+            return 0;
         }
 
         $extension = $this->findExtension($name);
@@ -101,7 +101,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
             $io->writeln(Yaml::dump([$extensionAlias => $config], 10));
 
-            return;
+            return 0;
         }
 
         try {
@@ -115,6 +115,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $io->title(sprintf('Current configuration for "%s.%s"', $extensionAlias, $path));
 
         $io->writeln(Yaml::dump($config, 10));
+
+        return 0;
     }
 
     private function compileContainer(): ContainerBuilder
diff --git a/Command/ContainerDebugCommand.php b/Command/ContainerDebugCommand.php
@@ -114,7 +114,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         if ($input->getOption('show-private')) {
             @trigger_error('The "--show-private" option no longer has any effect and is deprecated since Symfony 4.1.', E_USER_DEPRECATED);
@@ -184,6 +184,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
                 $errorIo->comment('To search for a specific service, re-run this command with a search term. (e.g. <comment>debug:container log</comment>)');
             }
         }
+
+        return 0;
     }
 
     /**
diff --git a/Command/EventDispatcherDebugCommand.php b/Command/EventDispatcherDebugCommand.php
@@ -69,7 +69,7 @@ protected function configure()
      *
      * @throws \LogicException
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
 
@@ -78,7 +78,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             if (!$this->dispatcher->hasListeners($event)) {
                 $io->getErrorStyle()->warning(sprintf('The event "%s" does not have any registered listeners.', $event));
 
-                return;
+                return 0;
             }
 
             $options = ['event' => $event];
@@ -89,5 +89,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $options['raw_text'] = $input->getOption('raw');
         $options['output'] = $io;
         $helper->describe($io, $this->dispatcher, $options);
+
+        return 0;
     }
 }
diff --git a/Command/RouterDebugCommand.php b/Command/RouterDebugCommand.php
@@ -73,7 +73,7 @@ protected function configure()
      *
      * @throws InvalidArgumentException When route does not exist
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
         $name = $input->getArgument('name');
@@ -105,6 +105,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
                 'output' => $io,
             ]);
         }
+
+        return 0;
     }
 
     private function findRouteNameContaining(string $name, RouteCollection $routes): array
diff --git a/Command/TranslationDebugCommand.php b/Command/TranslationDebugCommand.php
@@ -124,7 +124,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
 
@@ -246,7 +246,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
             $io->getErrorStyle()->warning($outputMessage);
 
-            return;
+            return 0;
         }
 
         // Load the fallback catalogues
@@ -295,6 +295,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
         }
 
         $io->table($headers, $rows);
+
+        return 0;
     }
 
     private function formatState(int $state): string
diff --git a/Command/WorkflowDumpCommand.php b/Command/WorkflowDumpCommand.php
@@ -59,7 +59,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $container = $this->getApplication()->getKernel()->getContainer();
         $serviceId = $input->getArgument('name');
@@ -97,5 +97,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             ],
         ];
         $output->writeln($dumper->dump($workflow->getDefinition(), $marking, $options));
+
+        return 0;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ protected function configure()`
`54`	`54`	`/**`
`55`	`55`	`* {@inheritdoc}`
`56`	`56`	`*/`
`57`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`57`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`58`	`58`	`{`
`59`	`59`	`$io = new SymfonyStyle($input, $output);`
`60`	`60`
`@@ -100,6 +100,8 @@ protected function execute(InputInterface $input, OutputInterface $output)`
`100`	`100`	`}`
`101`	`101`
`102`	`102`	`$io->table([], $rows);`
	`103`	`+`
	`104`	`+ return 0;`
`103`	`105`	`}`
`104`	`106`
`105`	`107`	`private static function formatPath(string $path, string $baseDir): string`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ protected function configure()`
`72`	`72`	`/**`
`73`	`73`	`* {@inheritdoc}`
`74`	`74`	`*/`
`75`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`75`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`76`	`76`	`{`
`77`	`77`	`$fs = $this->filesystem;`
`78`	`78`	`$io = new SymfonyStyle($input, $output);`
`@@ -175,6 +175,8 @@ protected function execute(InputInterface $input, OutputInterface $output)`
`175`	`175`	`}`
`176`	`176`
`177`	`177`	`$io->success(sprintf('Cache for the "%s" environment (debug=%s) was successfully cleared.', $kernel->getEnvironment(), var_export($kernel->isDebug(), true)));`
	`178`	`+`
	`179`	`+ return 0;`
`178`	`180`	`}`
`179`	`181`
`180`	`182`	`private function warmup(string $warmupDir, string $realCacheDir, bool $enableOptionalWarmers = true)`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ protected function configure()`
`60`	`60`	`/**`
`61`	`61`	`* {@inheritdoc}`
`62`	`62`	`*/`
`63`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`63`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`64`	`64`	`{`
`65`	`65`	`$io = new SymfonyStyle($input, $output);`
`66`	`66`	`$kernel = $this->getApplication()->getKernel();`
`@@ -99,5 +99,7 @@ protected function execute(InputInterface $input, OutputInterface $output)`
`99`	`99`	`}`
`100`	`100`
`101`	`101`	`$io->success('Cache was successfully cleared.');`
	`102`	`+`
	`103`	`+ return 0;`
`102`	`104`	`}`
`103`	`105`	`}`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ protected function configure()`
`59`	`59`	`/**`
`60`	`60`	`* {@inheritdoc}`
`61`	`61`	`*/`
`62`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`62`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`63`	`63`	`{`
`64`	`64`	`$io = new SymfonyStyle($input, $output);`
`65`	`65`	`$pool = $input->getArgument('pool');`
`@@ -69,13 +69,15 @@ protected function execute(InputInterface $input, OutputInterface $output)`
`69`	`69`	`if (!$cachePool->hasItem($key)) {`
`70`	`70`	`$io->note(sprintf('Cache item "%s" does not exist in cache pool "%s".', $key, $pool));`
`71`	`71`
`72`		`- return;`
	`72`	`+ return 0;`
`73`	`73`	`}`
`74`	`74`
`75`	`75`	`if (!$cachePool->deleteItem($key)) {`
`76`	`76`	`throw new \Exception(sprintf('Cache item "%s" could not be deleted.', $key));`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`$io->success(sprintf('Cache item "%s" was successfully deleted.', $key));`
	`80`	`+`
	`81`	`+ return 0;`
`80`	`82`	`}`
`81`	`83`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,12 +51,14 @@ protected function configure()`
`51`	`51`	`/**`
`52`	`52`	`* {@inheritdoc}`
`53`	`53`	`*/`
`54`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`54`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`55`	`55`	`{`
`56`	`56`	`$io = new SymfonyStyle($input, $output);`
`57`	`57`
`58`	`58`	`$io->table(['Pool name'], array_map(function ($pool) {`
`59`	`59`	`return [$pool];`
`60`	`60`	`}, $this->poolNames));`
	`61`	`+`
	`62`	`+ return 0;`
`61`	`63`	`}`
`62`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ protected function configure()`
`57`	`57`	`/**`
`58`	`58`	`* {@inheritdoc}`
`59`	`59`	`*/`
`60`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`60`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`61`	`61`	`{`
`62`	`62`	`$io = new SymfonyStyle($input, $output);`
`63`	`63`
`@@ -67,5 +67,7 @@ protected function execute(InputInterface $input, OutputInterface $output)`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`$io->success('Successfully pruned cache pool(s).');`
	`70`	`+`
	`71`	`+ return 0;`
`70`	`72`	`}`
`71`	`73`	`}`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ protected function configure()`
`66`	`66`	`/**`
`67`	`67`	`* {@inheritdoc}`
`68`	`68`	`*/`
`69`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`69`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`70`	`70`	`{`
`71`	`71`	`$io = new SymfonyStyle($input, $output);`
`72`	`72`
`@@ -80,5 +80,7 @@ protected function execute(InputInterface $input, OutputInterface $output)`
`80`	`80`	`$this->cacheWarmer->warmUp($kernel->getContainer()->getParameter('kernel.cache_dir'));`
`81`	`81`
`82`	`82`	`$io->success(sprintf('Cache for the "%s" environment (debug=%s) was successfully warmed.', $kernel->getEnvironment(), var_export($kernel->isDebug(), true)));`
	`83`	`+`
	`84`	`+ return 0;`
`83`	`85`	`}`
`84`	`86`	`}`
Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ protected function configure()`
`114`	`114`	`/**`
`115`	`115`	`* {@inheritdoc}`
`116`	`116`	`*/`
`117`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`117`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`118`	`118`	`{`
`119`	`119`	`if ($input->getOption('show-private')) {`
`120`	`120`	`@trigger_error('The "--show-private" option no longer has any effect and is deprecated since Symfony 4.1.', E_USER_DEPRECATED);`
`@@ -184,6 +184,8 @@ protected function execute(InputInterface $input, OutputInterface $output)`
`184`	`184`	`$errorIo->comment('To search for a specific service, re-run this command with a search term. (e.g. <comment>debug:container log</comment>)');`
`185`	`185`	`}`
`186`	`186`	`}`
	`187`	`+`
	`188`	`+ return 0;`
`187`	`189`	`}`
`188`	`190`
`189`	`191`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ protected function configure()`
`69`	`69`	`*`
`70`	`70`	`* @throws \LogicException`
`71`	`71`	`*/`
`72`		`- protected function execute(InputInterface $input, OutputInterface $output)`
	`72`	`+ protected function execute(InputInterface $input, OutputInterface $output): int`
`73`	`73`	`{`
`74`	`74`	`$io = new SymfonyStyle($input, $output);`
`75`	`75`
`@@ -78,7 +78,7 @@ protected function execute(InputInterface $input, OutputInterface $output)`
`78`	`78`	`if (!$this->dispatcher->hasListeners($event)) {`
`79`	`79`	`$io->getErrorStyle()->warning(sprintf('The event "%s" does not have any registered listeners.', $event));`
`80`	`80`
`81`		`- return;`
	`81`	`+ return 0;`
`82`	`82`	`}`
`83`	`83`
`84`	`84`	`$options = ['event' => $event];`
`@@ -89,5 +89,7 @@ protected function execute(InputInterface $input, OutputInterface $output)`
`89`	`89`	`$options['raw_text'] = $input->getOption('raw');`
`90`	`90`	`$options['output'] = $io;`
`91`	`91`	`$helper->describe($io, $this->dispatcher, $options);`
	`92`	`+`
	`93`	`+ return 0;`
`92`	`94`	`}`
`93`	`95`	`}`