Add all missing return types

wouterj · wouterj · commit 1b10b6fb39e5 · 2023-06-29T12:39:19.000+02:00
diff --git a/src/Symfony/Bridge/Doctrine/DataCollector/DoctrineDataCollector.php b/src/Symfony/Bridge/Doctrine/DataCollector/DoctrineDataCollector.php
@@ -113,11 +113,17 @@ public function reset()
         }
     }
 
+    /**
+     * @return array
+     */
     public function getManagers()
     {
         return $this->data['managers'];
     }
 
+    /**
+     * @return array
+     */
     public function getConnections()
     {
         return $this->data['connections'];
@@ -131,11 +137,17 @@ public function getQueryCount()
         return array_sum(array_map('count', $this->data['queries']));
     }
 
+    /**
+     * @return array
+     */
     public function getQueries()
     {
         return $this->data['queries'];
     }
 
+    /**
+     * @return int
+     */
     public function getTime()
     {
         $time = 0;
diff --git a/src/Symfony/Bridge/Doctrine/DependencyInjection/CompilerPass/RegisterEventListenersAndSubscribersPass.php b/src/Symfony/Bridge/Doctrine/DependencyInjection/CompilerPass/RegisterEventListenersAndSubscribersPass.php
@@ -53,6 +53,9 @@ public function __construct(string $connectionsParameter, string $managerTemplat
         $this->tagPrefix = $tagPrefix;
     }
 
+    /**
+     * @return void
+     */
     public function process(ContainerBuilder $container)
     {
         if (!$container->hasParameter($this->connectionsParameter)) {
diff --git a/src/Symfony/Bridge/Doctrine/Form/DoctrineOrmTypeGuesser.php b/src/Symfony/Bridge/Doctrine/Form/DoctrineOrmTypeGuesser.php
@@ -151,6 +151,15 @@ public function guessPattern(string $class, string $property): ?ValueGuess
         return null;
     }
 
+    /**
+     * @template T of object
+     *
+     * @psalm-param class-string<T> $className
+     *
+     * @return array|null
+     *
+     * @psalm-return array{0:ClassMetadata<T>, 1:string}
+     */
     protected function getMetadata(string $class)
     {
         // normalize class name
diff --git a/src/Symfony/Bridge/Monolog/Handler/ConsoleHandler.php b/src/Symfony/Bridge/Monolog/Handler/ConsoleHandler.php
@@ -129,6 +129,8 @@ private function doHandle(array|LogRecord $record): bool
 
     /**
      * Sets the console output to use for printing logs.
+     *
+     * @return void
      */
     public function setOutput(OutputInterface $output)
     {
@@ -148,6 +150,8 @@ public function close(): void
     /**
      * Before a command is executed, the handler gets activated and the console output
      * is set in order to know where to write the logs.
+     *
+     * @return void
      */
     public function onCommand(ConsoleCommandEvent $event)
     {
@@ -161,6 +165,8 @@ public function onCommand(ConsoleCommandEvent $event)
 
     /**
      * After a command has been executed, it disables the output.
+     *
+     * @return void
      */
     public function onTerminate(ConsoleTerminateEvent $event)
     {
diff --git a/src/Symfony/Bridge/Monolog/Handler/ServerLogHandler.php b/src/Symfony/Bridge/Monolog/Handler/ServerLogHandler.php
@@ -130,6 +130,9 @@ private static function nullErrorHandler(): void
     {
     }
 
+    /**
+     * @return resource
+     */
     private function createSocket()
     {
         $socket = stream_socket_client($this->host, $errno, $errstr, 0, \STREAM_CLIENT_CONNECT | \STREAM_CLIENT_ASYNC_CONNECT | \STREAM_CLIENT_PERSISTENT, $this->context);
diff --git a/src/Symfony/Bridge/Twig/DataCollector/TwigDataCollector.php b/src/Symfony/Bridge/Twig/DataCollector/TwigDataCollector.php
@@ -134,7 +134,7 @@ public function getProfile(): Profile
         return $this->profile ??= unserialize($this->data['profile'], ['allowed_classes' => ['Twig_Profiler_Profile', Profile::class]]);
     }
 
-    private function getComputedData(string $index)
+    private function getComputedData(string $index): mixed
     {
         $this->computed ??= $this->computeData($this->getProfile());
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/AbstractConfigCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/AbstractConfigCommand.php
@@ -28,6 +28,9 @@
  */
 abstract class AbstractConfigCommand extends ContainerDebugCommand
 {
+    /**
+     * @return void
+     */
     protected function listBundles(OutputInterface|StyleInterface $output)
     {
         $title = 'Available registered bundles with their extension alias if available';
@@ -156,6 +159,9 @@ protected function findExtension(string $name): ExtensionInterface
         throw new LogicException($message);
     }
 
+    /**
+     * @return void
+     */
     public function validateConfiguration(ExtensionInterface $extension, mixed $configuration)
     {
         if (!$configuration) {
diff --git a/src/Symfony/Bundle/FrameworkBundle/DataCollector/RouterDataCollector.php b/src/Symfony/Bundle/FrameworkBundle/DataCollector/RouterDataCollector.php
@@ -22,7 +22,7 @@
  */
 class RouterDataCollector extends BaseRouterDataCollector
 {
-    public function guessRoute(Request $request, mixed $controller)
+    public function guessRoute(Request $request, mixed $controller): string
     {
         if (\is_array($controller)) {
             $controller = $controller[0];
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -1864,7 +1864,7 @@ private function addHttpClientSection(ArrayNodeDefinition $rootNode, callable $e
                                     ->normalizeKeys(false)
                                     ->variablePrototype()->end()
                                 ->end()
-                                ->append($this->addHttpClientRetrySection())
+                                ->append($this->createHttpClientRetrySection())
                             ->end()
                         ->end()
                         ->scalarNode('mock_response_factory')
@@ -2012,7 +2012,7 @@ private function addHttpClientSection(ArrayNodeDefinition $rootNode, callable $e
                                         ->normalizeKeys(false)
                                         ->variablePrototype()->end()
                                     ->end()
-                                    ->append($this->addHttpClientRetrySection())
+                                    ->append($this->createHttpClientRetrySection())
                                 ->end()
                             ->end()
                         ->end()
@@ -2022,7 +2022,7 @@ private function addHttpClientSection(ArrayNodeDefinition $rootNode, callable $e
         ;
     }
 
-    private function addHttpClientRetrySection()
+    private function createHttpClientRetrySection(): NodeBuilder
     {
         $root = new NodeBuilder();
 
@@ -2226,7 +2226,7 @@ private function addWebhookSection(ArrayNodeDefinition $rootNode, callable $enab
         ;
     }
 
-    private function addRemoteEventSection(ArrayNodeDefinition $rootNode, callable $enableIfStandalone)
+    private function addRemoteEventSection(ArrayNodeDefinition $rootNode, callable $enableIfStandalone): void
     {
         $rootNode
             ->children()
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -2831,7 +2831,7 @@ private function registerNotifierConfiguration(array $config, ContainerBuilder $
         }
     }
 
-    private function registerWebhookConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
+    private function registerWebhookConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader): void
     {
         if (!class_exists(WebhookController::class)) {
             throw new LogicException('Webhook support cannot be enabled as the component is not installed. Try running "composer require symfony/webhook".');
@@ -2852,7 +2852,7 @@ private function registerWebhookConfiguration(array $config, ContainerBuilder $c
         $controller->replaceArgument(1, new Reference($config['message_bus']));
     }
 
-    private function registerRemoteEventConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)
+    private function registerRemoteEventConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader): void
     {
         if (!class_exists(RemoteEvent::class)) {
             throw new LogicException('RemoteEvent support cannot be enabled as the component is not installed. Try running "composer require symfony/remote-event".');
diff --git a/src/Symfony/Bundle/SecurityBundle/DependencyInjection/SecurityExtension.php b/src/Symfony/Bundle/SecurityBundle/DependencyInjection/SecurityExtension.php
@@ -593,7 +593,7 @@ private function createFirewall(ContainerBuilder $container, string $id, array $
         return [$matcher, $listeners, $exceptionListener, null !== $logoutListenerId ? new Reference($logoutListenerId) : null, $firewallAuthenticationProviders];
     }
 
-    private function createContextListener(ContainerBuilder $container, string $contextKey, ?string $firewallEventDispatcherId)
+    private function createContextListener(ContainerBuilder $container, string $contextKey, ?string $firewallEventDispatcherId): string
     {
         if (isset($this->contextListeners[$contextKey])) {
             return $this->contextListeners[$contextKey];
diff --git a/src/Symfony/Component/Form/Extension/DataCollector/FormDataCollector.php b/src/Symfony/Component/Form/Extension/DataCollector/FormDataCollector.php
@@ -242,6 +242,9 @@ protected function getCasters(): array
         ];
     }
 
+    /**
+     * @return array
+     */
     private function &recursiveBuildPreliminaryFormTree(FormInterface $form, array &$outputByHash)
     {
         $hash = spl_object_hash($form);
@@ -259,6 +262,9 @@ private function &recursiveBuildPreliminaryFormTree(FormInterface $form, array &
         return $output;
     }
 
+    /**
+     * @return array
+     */
     private function &recursiveBuildFinalFormTree(FormInterface $form = null, FormView $view, array &$outputByHash)
     {
         $viewHash = spl_object_hash($view);
diff --git a/src/Symfony/Component/HttpKernel/DataCollector/ConfigDataCollector.php b/src/Symfony/Component/HttpKernel/DataCollector/ConfigDataCollector.php
@@ -224,7 +224,7 @@ public function hasZendOpcache(): bool
         return $this->data['zend_opcache_enabled'];
     }
 
-    public function getBundles()
+    public function getBundles(): array
     {
         return $this->data['bundles'];
     }
diff --git a/src/Symfony/Component/HttpKernel/DataCollector/LoggerDataCollector.php b/src/Symfony/Component/HttpKernel/DataCollector/LoggerDataCollector.php
@@ -16,6 +16,7 @@
 use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Log\DebugLoggerInterface;
+use Symfony\Component\VarDumper\Cloner\Data;
 
 /**
  * @author Fabien Potencier <fabien@symfony.com>
@@ -67,12 +68,12 @@ public function lateCollect(): void
         $this->currentRequest = null;
     }
 
-    public function getLogs()
+    public function getLogs(): array
     {
         return $this->data['logs'] ?? [];
     }
 
-    public function getProcessedLogs()
+    public function getProcessedLogs(): array
     {
         if (null !== $this->processedLogs) {
             return $this->processedLogs;
@@ -115,7 +116,7 @@ public function getProcessedLogs()
         return $this->processedLogs = $logs;
     }
 
-    public function getFilters()
+    public function getFilters(): array
     {
         $filters = [
             'channel' => [],
@@ -146,32 +147,32 @@ public function getFilters()
         return $filters;
     }
 
-    public function getPriorities()
+    public function getPriorities(): array
     {
         return $this->data['priorities'] ?? [];
     }
 
-    public function countErrors()
+    public function countErrors(): int
     {
         return $this->data['error_count'] ?? 0;
     }
 
-    public function countDeprecations()
+    public function countDeprecations(): int
     {
         return $this->data['deprecation_count'] ?? 0;
     }
 
-    public function countWarnings()
+    public function countWarnings(): int
     {
         return $this->data['warning_count'] ?? 0;
     }
 
-    public function countScreams()
+    public function countScreams(): int
     {
         return $this->data['scream_count'] ?? 0;
     }
 
-    public function getCompilerLogs()
+    public function getCompilerLogs(): Data
     {
         return $this->cloneVar($this->getContainerCompilerLogs($this->data['compiler_logs_filepath'] ?? null));
     }
diff --git a/src/Symfony/Component/HttpKernel/DataCollector/RequestDataCollector.php b/src/Symfony/Component/HttpKernel/DataCollector/RequestDataCollector.php
diff --git a/src/Symfony/Component/Messenger/DataCollector/MessengerDataCollector.php b/src/Symfony/Component/Messenger/DataCollector/MessengerDataCollector.php
diff --git a/src/Symfony/Component/Translation/DataCollector/TranslationDataCollector.php b/src/Symfony/Component/Translation/DataCollector/TranslationDataCollector.php

Original file line number	Diff line number	Diff line change
`@@ -113,11 +113,17 @@ public function reset()`
`113`	`113`	`}`
`114`	`114`	`}`
`115`	`115`
	`116`	`+ /**`
	`117`	`+ * @return array`
	`118`	`+ */`
`116`	`119`	`public function getManagers()`
`117`	`120`	`{`
`118`	`121`	`return $this->data['managers'];`
`119`	`122`	`}`
`120`	`123`
	`124`	`+ /**`
	`125`	`+ * @return array`
	`126`	`+ */`
`121`	`127`	`public function getConnections()`
`122`	`128`	`{`
`123`	`129`	`return $this->data['connections'];`
`@@ -131,11 +137,17 @@ public function getQueryCount()`
`131`	`137`	`return array_sum(array_map('count', $this->data['queries']));`
`132`	`138`	`}`
`133`	`139`
	`140`	`+ /**`
	`141`	`+ * @return array`
	`142`	`+ */`
`134`	`143`	`public function getQueries()`
`135`	`144`	`{`
`136`	`145`	`return $this->data['queries'];`
`137`	`146`	`}`
`138`	`147`
	`148`	`+ /**`
	`149`	`+ * @return int`
	`150`	`+ */`
`139`	`151`	`public function getTime()`
`140`	`152`	`{`
`141`	`153`	`$time = 0;`
Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,9 @@ public function __construct(string $connectionsParameter, string $managerTemplat`
`53`	`53`	`$this->tagPrefix = $tagPrefix;`
`54`	`54`	`}`
`55`	`55`
	`56`	`+ /**`
	`57`	`+ * @return void`
	`58`	`+ */`
`56`	`59`	`public function process(ContainerBuilder $container)`
`57`	`60`	`{`
`58`	`61`	`if (!$container->hasParameter($this->connectionsParameter)) {`
Original file line number	Diff line number	Diff line change
`@@ -130,6 +130,9 @@ private static function nullErrorHandler(): void`
`130`	`130`	`{`
`131`	`131`	`}`
`132`	`132`
	`133`	`+ /**`
	`134`	`+ * @return resource`
	`135`	`+ */`
`133`	`136`	`private function createSocket()`
`134`	`137`	`{`
`135`	`138`	`$socket = stream_socket_client($this->host, $errno, $errstr, 0, \STREAM_CLIENT_CONNECT \| \STREAM_CLIENT_ASYNC_CONNECT \| \STREAM_CLIENT_PERSISTENT, $this->context);`
Original file line number	Diff line number	Diff line change
`@@ -134,7 +134,7 @@ public function getProfile(): Profile`
`134`	`134`	`return $this->profile ??= unserialize($this->data['profile'], ['allowed_classes' => ['Twig_Profiler_Profile', Profile::class]]);`
`135`	`135`	`}`
`136`	`136`
`137`		`- private function getComputedData(string $index)`
	`137`	`+ private function getComputedData(string $index): mixed`
`138`	`138`	`{`
`139`	`139`	`$this->computed ??= $this->computeData($this->getProfile());`
`140`	`140`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,9 @@`
`28`	`28`	`*/`
`29`	`29`	`abstract class AbstractConfigCommand extends ContainerDebugCommand`
`30`	`30`	`{`
	`31`	`+ /**`
	`32`	`+ * @return void`
	`33`	`+ */`
`31`	`34`	`protected function listBundles(OutputInterface\|StyleInterface $output)`
`32`	`35`	`{`
`33`	`36`	`$title = 'Available registered bundles with their extension alias if available';`
`@@ -156,6 +159,9 @@ protected function findExtension(string $name): ExtensionInterface`
`156`	`159`	`throw new LogicException($message);`
`157`	`160`	`}`
`158`	`161`
	`162`	`+ /**`
	`163`	`+ * @return void`
	`164`	`+ */`
`159`	`165`	`public function validateConfiguration(ExtensionInterface $extension, mixed $configuration)`
`160`	`166`	`{`
`161`	`167`	`if (!$configuration) {`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`*/`
`23`	`23`	`class RouterDataCollector extends BaseRouterDataCollector`
`24`	`24`	`{`
`25`		`- public function guessRoute(Request $request, mixed $controller)`
	`25`	`+ public function guessRoute(Request $request, mixed $controller): string`
`26`	`26`	`{`
`27`	`27`	`if (\is_array($controller)) {`
`28`	`28`	`$controller = $controller[0];`
Original file line number	Diff line number	Diff line change
`@@ -1864,7 +1864,7 @@ private function addHttpClientSection(ArrayNodeDefinition $rootNode, callable $e`
`1864`	`1864`	`->normalizeKeys(false)`
`1865`	`1865`	`->variablePrototype()->end()`
`1866`	`1866`	`->end()`
`1867`		`- ->append($this->addHttpClientRetrySection())`
	`1867`	`+ ->append($this->createHttpClientRetrySection())`
`1868`	`1868`	`->end()`
`1869`	`1869`	`->end()`
`1870`	`1870`	`->scalarNode('mock_response_factory')`
`@@ -2012,7 +2012,7 @@ private function addHttpClientSection(ArrayNodeDefinition $rootNode, callable $e`
`2012`	`2012`	`->normalizeKeys(false)`
`2013`	`2013`	`->variablePrototype()->end()`
`2014`	`2014`	`->end()`
`2015`		`- ->append($this->addHttpClientRetrySection())`
	`2015`	`+ ->append($this->createHttpClientRetrySection())`
`2016`	`2016`	`->end()`
`2017`	`2017`	`->end()`
`2018`	`2018`	`->end()`
`@@ -2022,7 +2022,7 @@ private function addHttpClientSection(ArrayNodeDefinition $rootNode, callable $e`
`2022`	`2022`	`;`
`2023`	`2023`	`}`
`2024`	`2024`
`2025`		`- private function addHttpClientRetrySection()`
	`2025`	`+ private function createHttpClientRetrySection(): NodeBuilder`
`2026`	`2026`	`{`
`2027`	`2027`	`$root = new NodeBuilder();`
`2028`	`2028`
`@@ -2226,7 +2226,7 @@ private function addWebhookSection(ArrayNodeDefinition $rootNode, callable $enab`
`2226`	`2226`	`;`
`2227`	`2227`	`}`
`2228`	`2228`
`2229`		`- private function addRemoteEventSection(ArrayNodeDefinition $rootNode, callable $enableIfStandalone)`
	`2229`	`+ private function addRemoteEventSection(ArrayNodeDefinition $rootNode, callable $enableIfStandalone): void`
`2230`	`2230`	`{`
`2231`	`2231`	`$rootNode`
`2232`	`2232`	`->children()`
Original file line number	Diff line number	Diff line change
`@@ -2831,7 +2831,7 @@ private function registerNotifierConfiguration(array $config, ContainerBuilder $`
`2831`	`2831`	`}`
`2832`	`2832`	`}`
`2833`	`2833`
`2834`		`- private function registerWebhookConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)`
	`2834`	`+ private function registerWebhookConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader): void`
`2835`	`2835`	`{`
`2836`	`2836`	`if (!class_exists(WebhookController::class)) {`
`2837`	`2837`	`throw new LogicException('Webhook support cannot be enabled as the component is not installed. Try running "composer require symfony/webhook".');`
`@@ -2852,7 +2852,7 @@ private function registerWebhookConfiguration(array $config, ContainerBuilder $c`
`2852`	`2852`	`$controller->replaceArgument(1, new Reference($config['message_bus']));`
`2853`	`2853`	`}`
`2854`	`2854`
`2855`		`- private function registerRemoteEventConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)`
	`2855`	`+ private function registerRemoteEventConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader): void`
`2856`	`2856`	`{`
`2857`	`2857`	`if (!class_exists(RemoteEvent::class)) {`
`2858`	`2858`	`throw new LogicException('RemoteEvent support cannot be enabled as the component is not installed. Try running "composer require symfony/remote-event".');`