[Components] Convert to native return types

Author: wouterj

Application.php

@@ -110,10 +110,7 @@ public function setDispatcher(EventDispatcherInterface $dispatcher): void
         $this->dispatcher = $dispatcher;
     }
 
-    /**
-     * @return void
-     */
-    public function setCommandLoader(CommandLoaderInterface $commandLoader)
+    public function setCommandLoader(CommandLoaderInterface $commandLoader): void
     {
         $this->commandLoader = $commandLoader;
     }
@@ -127,10 +124,7 @@ public function getSignalRegistry(): SignalRegistry
         return $this->signalRegistry;
     }
 
-    /**
-     * @return void
-     */
-    public function setSignalsToDispatchEvent(int ...$signalsToDispatchEvent)
+    public function setSignalsToDispatchEvent(int ...$signalsToDispatchEvent): void
     {
         $this->signalsToDispatchEvent = $signalsToDispatchEvent;
     }
@@ -220,7 +214,7 @@ public function run(InputInterface $input = null, OutputInterface $output = null
      *
      * @return int 0 if everything went fine, or an error code
      */
-    public function doRun(InputInterface $input, OutputInterface $output)
+    public function doRun(InputInterface $input, OutputInterface $output): int
     {
         if (true === $input->hasParameterOption(['--version', '-V'], true)) {
             $output->writeln($this->getLongVersion());
@@ -323,17 +317,11 @@ public function doRun(InputInterface $input, OutputInterface $output)
         return $exitCode;
     }
 
-    /**
-     * @return void
-     */
-    public function reset()
+    public function reset(): void
     {
     }
 
-    /**
-     * @return void
-     */
-    public function setHelperSet(HelperSet $helperSet)
+    public function setHelperSet(HelperSet $helperSet): void
     {
         $this->helperSet = $helperSet;
     }
@@ -346,10 +334,7 @@ public function getHelperSet(): HelperSet
         return $this->helperSet ??= $this->getDefaultHelperSet();
     }
 
-    /**
-     * @return void
-     */
-    public function setDefinition(InputDefinition $definition)
+    public function setDefinition(InputDefinition $definition): void
     {
         $this->definition = $definition;
     }
@@ -419,10 +404,8 @@ public function areExceptionsCaught(): bool
 
     /**
      * Sets whether to catch exceptions or not during commands execution.
-     *
-     * @return void
      */
-    public function setCatchExceptions(bool $boolean)
+    public function setCatchExceptions(bool $boolean): void
     {
         $this->catchExceptions = $boolean;
     }
@@ -437,10 +420,8 @@ public function isAutoExitEnabled(): bool
 
     /**
      * Sets whether to automatically exit after a command execution or not.
-     *
-     * @return void
      */
-    public function setAutoExit(bool $boolean)
+    public function setAutoExit(bool $boolean): void
     {
         $this->autoExit = $boolean;
     }
@@ -455,10 +436,8 @@ public function getName(): string
 
     /**
      * Sets the application name.
-     *
-     * @return void
      */
-    public function setName(string $name)
+    public function setName(string $name): void
     {
         $this->name = $name;
     }
@@ -473,20 +452,16 @@ public function getVersion(): string
 
     /**
      * Sets the application version.
-     *
-     * @return void
      */
-    public function setVersion(string $version)
+    public function setVersion(string $version): void
     {
         $this->version = $version;
     }
 
     /**
      * Returns the long version of the application.
-     *
-     * @return string
      */
-    public function getLongVersion()
+    public function getLongVersion(): string
     {
         if ('UNKNOWN' !== $this->getName()) {
             if ('UNKNOWN' !== $this->getVersion()) {
@@ -513,10 +488,8 @@ public function register(string $name): Command
      * If a Command is not enabled it will not be added.
      *
      * @param Command[] $commands An array of commands
-     *
-     * @return void
      */
-    public function addCommands(array $commands)
+    public function addCommands(array $commands): void
     {
         foreach ($commands as $command) {
             $this->add($command);
@@ -528,10 +501,8 @@ public function addCommands(array $commands)
      *
      * If a command with the same name already exists, it will be overridden.
      * If the command is not enabled it will not be added.
-     *
-     * @return Command|null
      */
-    public function add(Command $command)
+    public function add(Command $command): ?Command
     {
         $this->init();
 
@@ -564,11 +535,9 @@ public function add(Command $command)
     /**
      * Returns a registered command by name or alias.
      *
-     * @return Command
-     *
      * @throws CommandNotFoundException When given command name does not exist
      */
-    public function get(string $name)
+    public function get(string $name): Command
     {
         $this->init();
 
@@ -671,11 +640,9 @@ public function findNamespace(string $namespace): string
      * Contrary to get, this command tries to find the best
      * match if you give it an abbreviation of a name or alias.
      *
-     * @return Command
-     *
      * @throws CommandNotFoundException When command name is incorrect or ambiguous
      */
-    public function find(string $name)
+    public function find(string $name): Command
     {
         $this->init();
 
@@ -783,7 +750,7 @@ public function find(string $name)
      *
      * @return Command[]
      */
-    public function all(string $namespace = null)
+    public function all(string $namespace = null): array
     {
         $this->init();
 
@@ -924,10 +891,8 @@ protected function doRenderThrowable(\Throwable $e, OutputInterface $output): vo
 
     /**
      * Configures the input and output instances based on the user arguments and options.
-     *
-     * @return void
      */
-    protected function configureIO(InputInterface $input, OutputInterface $output)
+    protected function configureIO(InputInterface $input, OutputInterface $output): void
     {
         if (true === $input->hasParameterOption(['--ansi'], true)) {
             $output->setDecorated(true);
@@ -992,7 +957,7 @@ protected function configureIO(InputInterface $input, OutputInterface $output)
      *
      * @return int 0 if everything went fine, or an error code
      */
-    protected function doRunCommand(Command $command, InputInterface $input, OutputInterface $output)
+    protected function doRunCommand(Command $command, InputInterface $input, OutputInterface $output): int
     {
         foreach ($command->getHelperSet() as $helper) {
             if ($helper instanceof InputAwareInterface) {

Command/Command.php

@@ -107,18 +107,13 @@ public function __construct(string $name = null)
      * Ignores validation errors.
      *
      * This is mainly useful for the help command.
-     *
-     * @return void
      */
-    public function ignoreValidationErrors()
+    public function ignoreValidationErrors(): void
     {
         $this->ignoreValidationErrors = true;
     }
 
-    /**
-     * @return void
-     */
-    public function setApplication(?Application $application)
+    public function setApplication(?Application $application): void
     {
         $this->application = $application;
         if ($application) {
@@ -130,10 +125,7 @@ public function setApplication(?Application $application)
         $this->fullDefinition = null;
     }
 
-    /**
-     * @return void
-     */
-    public function setHelperSet(HelperSet $helperSet)
+    public function setHelperSet(HelperSet $helperSet): void
     {
         $this->helperSet = $helperSet;
     }
@@ -159,20 +151,16 @@ public function getApplication(): ?Application
      *
      * Override this to check for x or y and return false if the command cannot
      * run properly under the current conditions.
-     *
-     * @return bool
      */
-    public function isEnabled()
+    public function isEnabled(): bool
     {
         return true;
     }
 
     /**
      * Configures the current command.
-     *
-     * @return void
      */
-    protected function configure()
+    protected function configure(): void
     {
     }
 
@@ -190,7 +178,7 @@ protected function configure()
      *
      * @see setCode()
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         throw new LogicException('You must override the execute() method in the concrete command class.');
     }
@@ -201,10 +189,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
      * This method is executed before the InputDefinition is validated.
      * This means that this is the only place where the command can
      * interactively ask for values of missing required arguments.
-     *
-     * @return void
      */
-    protected function interact(InputInterface $input, OutputInterface $output)
+    protected function interact(InputInterface $input, OutputInterface $output): void
     {
     }
 
@@ -217,10 +203,8 @@ protected function interact(InputInterface $input, OutputInterface $output)
      *
      * @see InputInterface::bind()
      * @see InputInterface::validate()
-     *
-     * @return void
      */
-    protected function initialize(InputInterface $input, OutputInterface $output)
+    protected function initialize(InputInterface $input, OutputInterface $output): void
     {
     }
 
@@ -650,12 +634,10 @@ public function getUsages(): array
     /**
      * Gets a helper instance by name.
      *
-     * @return HelperInterface
-     *
      * @throws LogicException           if no HelperSet is defined
      * @throws InvalidArgumentException if the helper is not defined
      */
-    public function getHelper(string $name): mixed
+    public function getHelper(string $name): HelperInterface
     {
         if (null === $this->helperSet) {
             throw new LogicException(sprintf('Cannot retrieve helper "%s" because there is no HelperSet defined. Did you forget to add your command to the application or to set the application on the command using the setApplication() method? You can also set the HelperSet directly using the setHelperSet() method.', $name));

Command/HelpCommand.php

@@ -27,10 +27,7 @@ class HelpCommand extends Command
 {
     private Command $command;
 
-    /**
-     * @return void
-     */
-    protected function configure()
+    protected function configure(): void
     {
         $this->ignoreValidationErrors();
 
@@ -57,10 +54,7 @@ protected function configure()
         ;
     }
 
-    /**
-     * @return void
-     */
-    public function setCommand(Command $command)
+    public function setCommand(Command $command): void
     {
         $this->command = $command;
     }

Command/ListCommand.php

@@ -25,10 +25,7 @@
  */
 class ListCommand extends Command
 {
-    /**
-     * @return void
-     */
-    protected function configure()
+    protected function configure(): void
     {
         $this
             ->setName('list')

Command/SignalableCommandInterface.php

@@ -28,5 +28,5 @@ public function getSubscribedSignals(): array;
      *
      * @return int|false The exit code to return or false to continue the normal execution
      */
-    public function handleSignal(int $signal, int|false $previousExitCode = 0);
+    public function handleSignal(int $signal, int|false $previousExitCode = 0): int|false;
 }

DependencyInjection/AddConsoleCommandPass.php

@@ -29,10 +29,7 @@
  */
 class AddConsoleCommandPass implements CompilerPassInterface
 {
-    /**
-     * @return void
-     */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         $commandServices = $container->findTaggedServiceIds('console.command', true);
         $lazyCommandMap = [];

Descriptor/DescriptorInterface.php

@@ -20,8 +20,5 @@
  */
 interface DescriptorInterface
 {
-    /**
-     * @return void
-     */
-    public function describe(OutputInterface $output, object $object, array $options = []);
+    public function describe(OutputInterface $output, object $object, array $options = []): void;
 }

EventListener/ErrorListener.php

@@ -31,10 +31,7 @@ public function __construct(LoggerInterface $logger = null)
         $this->logger = $logger;
     }
 
-    /**
-     * @return void
-     */
-    public function onConsoleError(ConsoleErrorEvent $event)
+    public function onConsoleError(ConsoleErrorEvent $event): void
     {
         if (null === $this->logger) {
             return;
@@ -51,10 +48,7 @@ public function onConsoleError(ConsoleErrorEvent $event)
         $this->logger->critical('Error thrown while running command "{command}". Message: "{message}"', ['exception' => $error, 'command' => $inputString, 'message' => $error->getMessage()]);
     }
 
-    /**
-     * @return void
-     */
-    public function onConsoleTerminate(ConsoleTerminateEvent $event)
+    public function onConsoleTerminate(ConsoleTerminateEvent $event): void
     {
         if (null === $this->logger) {
             return;