symfony · nicolas-grekas · Apr 28, 2023 · Apr 28, 2023
diff --git a/.github/expected-missing-return-types.diff b/.github/expected-missing-return-types.diff
diff --git a/src/Symfony/Component/HttpClient/Response/StreamWrapper.php b/src/Symfony/Component/HttpClient/Response/StreamWrapper.php
@@ -32,7 +32,7 @@ class StreamWrapper
     /** @var resource|string|null */
     private $content;
 
-    /** @var resource|null */
+    /** @var resource|callable|null */
     private $handle;
 
     private bool $blocking = true;
@@ -266,6 +266,9 @@ public function stream_seek(int $offset, int $whence = \SEEK_SET): bool
         return false;
     }
 
+    /**
+     * @return resource|false
+     */
     public function stream_cast(int $castAs)
     {
         if (\STREAM_CAST_FOR_SELECT === $castAs) {

diff --git a/src/Symfony/Component/HttpFoundation/Request.php b/src/Symfony/Component/HttpFoundation/Request.php
@@ -1732,6 +1732,9 @@ public function preferSafeContent(): bool
      * Copyright (c) 2005-2010 Zend Technologies USA Inc. (https://www.zend.com/)
      */
 
+    /**
+     * @return string
+     */
     protected function prepareRequestUri()
     {
         $requestUri = '';

diff --git a/src/Symfony/Component/HttpKernel/DependencyInjection/ConfigurableExtension.php b/src/Symfony/Component/HttpKernel/DependencyInjection/ConfigurableExtension.php
@@ -34,6 +34,8 @@ final public function load(array $configs, ContainerBuilder $container): void
 
     /**
      * Configures the passed container according to the merged configuration.
+     *
+     * @return void
      */
     abstract protected function loadInternal(array $mergedConfig, ContainerBuilder $container);
 }
@@ -167,7 +167,7 @@ protected function loadUser(string $identifier, Entry $entry): UserInterface
         return new LdapUser($entry, $identifier, $password, $this->defaultRoles, $extraFields);
     }
 
-    private function getAttributeValue(Entry $entry, string $attribute)
+    private function getAttributeValue(Entry $entry, string $attribute): mixed
     {
         if (!$entry->hasAttribute($attribute)) {
             throw new InvalidArgumentException(sprintf('Missing attribute "%s" for user "%s".', $attribute, $entry->getDn()));

diff --git a/src/Symfony/Component/Mailer/Bridge/Mailjet/Transport/MailjetApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Mailjet/Transport/MailjetApiTransport.php
@@ -199,7 +199,7 @@ private function getEndpoint(): ?string
         return ($this->host ?: self::HOST).($this->port ? ':'.$this->port : '');
     }
 
-    private function castCustomHeader(string $value, string $type)
+    private function castCustomHeader(string $value, string $type): mixed
     {
         return match ($type) {
             'bool' => filter_var($value, \FILTER_VALIDATE_BOOL),

diff --git a/src/Symfony/Component/Mime/Email.php b/src/Symfony/Component/Mime/Email.php
@@ -396,6 +396,9 @@ public function getBody(): AbstractPart
         return $this->generateBody();
     }
 
+    /**
+     * @return void
+     */
     public function ensureValidity()
     {
         $this->ensureBodyValid();

diff --git a/src/Symfony/Component/Process/Exception/ProcessFailedException.php b/src/Symfony/Component/Process/Exception/ProcessFailedException.php
@@ -47,6 +47,9 @@ public function __construct(Process $process)
         $this->process = $process;
     }
 
+    /**
+     * @return Process
+     */
     public function getProcess()
     {
         return $this->process;

diff --git a/src/Symfony/Component/Process/Exception/ProcessTimedOutException.php b/src/Symfony/Component/Process/Exception/ProcessTimedOutException.php
@@ -38,6 +38,9 @@ public function __construct(Process $process, int $timeoutType)
         ));
     }
 
+    /**
+     * @return Process
+     */
     public function getProcess()
     {
         return $this->process;
@@ -59,7 +62,7 @@ public function isIdleTimeout()
         return self::TYPE_IDLE === $this->timeoutType;
     }
 
-    public function getExceededTimeout()
+    public function getExceededTimeout(): ?float
     {
         return match ($this->timeoutType) {
             self::TYPE_GENERAL => $this->process->getTimeout(),

diff --git a/src/Symfony/Component/Process/Process.php b/src/Symfony/Component/Process/Process.php
@@ -285,6 +285,8 @@ public function mustRun(callable $callback = null, array $env = []): static
      * @param callable|null $callback A PHP callback to run whenever there is some
      *                                output available on STDOUT or STDERR
      *
+     * @return void
+     *
      * @throws RuntimeException When process can't be launched
      * @throws RuntimeException When process is already running
      * @throws LogicException   In case a callback is provided and output has been disabled
@@ -1140,6 +1142,8 @@ public function setInput(mixed $input): static
      * In case you run a background process (with the start method), you should
      * trigger this method regularly to ensure the process timeout
      *
+     * @return void
+     *
      * @throws ProcessTimedOutException In case the timeout was reached
      */
     public function checkTimeout()
@@ -1180,6 +1184,8 @@ public function getStartTime(): float
      *
      * Enabling the "create_new_console" option allows a subprocess to continue
      * to run after the main process exited, on both Windows and *nix
+     *
+     * @return void
      */
     public function setOptions(array $options)
     {
@@ -1275,6 +1281,8 @@ protected function buildCallback(callable $callback = null): \Closure
      * Updates the status of the process, reads pipes.
      *
      * @param bool $blocking Whether to use a blocking read call
+     *
+     * @return void
      */
     protected function updateStatus(bool $blocking)
     {
@@ -1323,7 +1331,7 @@ protected function isSigchildEnabled(): bool
      *
      * @throws LogicException in case output has been disabled or process is not started
      */
-    private function readPipesForOutput(string $caller, bool $blocking = false)
+    private function readPipesForOutput(string $caller, bool $blocking = false): void
     {
         if ($this->outputDisabled) {
             throw new LogicException('Output has been disabled.');
@@ -1358,7 +1366,7 @@ private function validateTimeout(?float $timeout): ?float
      * @param bool $blocking Whether to use blocking calls or not
      * @param bool $close    Whether to close file handles or not
      */
-    private function readPipes(bool $blocking, bool $close)
+    private function readPipes(bool $blocking, bool $close): void
     {
         $result = $this->processPipes->readAndWrite($blocking, $close);
 
@@ -1407,7 +1415,7 @@ private function close(): int
     /**
      * Resets data related to the latest run of the process.
      */
-    private function resetProcessData()
+    private function resetProcessData(): void
     {
         $this->starttime = null;
         $this->callback = null;
@@ -1528,7 +1536,7 @@ function ($m) use (&$env, $uid) {
      *
      * @throws LogicException if the process has not run
      */
-    private function requireProcessIsStarted(string $functionName)
+    private function requireProcessIsStarted(string $functionName): void
     {
         if (!$this->isStarted()) {
             throw new LogicException(sprintf('Process must be started before calling "%s()".', $functionName));
@@ -1540,7 +1548,7 @@ private function requireProcessIsStarted(string $functionName)
      *
      * @throws LogicException if the process is not yet terminated
      */
-    private function requireProcessIsTerminated(string $functionName)
+    private function requireProcessIsTerminated(string $functionName): void
     {
         if (!$this->isTerminated()) {
             throw new LogicException(sprintf('Process must be terminated before calling "%s()".', $functionName));

diff --git a/src/Symfony/Component/Routing/Loader/AnnotationClassLoader.php b/src/Symfony/Component/Routing/Loader/AnnotationClassLoader.php
@@ -358,6 +358,9 @@ protected function createRoute(string $path, array $defaults, array $requirement
         return new Route($path, $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
     }
 
+    /**
+     * @return void
+     */
     abstract protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, object $annot);
 
     /**

diff --git a/src/Symfony/Component/Routing/Matcher/UrlMatcher.php b/src/Symfony/Component/Routing/Matcher/UrlMatcher.php
@@ -255,6 +255,9 @@ protected function mergeDefaults(array $params, array $defaults): array
         return $defaults;
     }
 
+    /**
+     * @return ExpressionLanguage
+     */
     protected function getExpressionLanguage()
     {
         if (null === $this->expressionLanguage) {

diff --git a/src/Symfony/Component/Routing/Router.php b/src/Symfony/Component/Routing/Router.php
@@ -178,6 +178,9 @@ public function getOption(string $key): mixed
         return $this->options[$key];
     }
 
+    /**
+     * @return RouteCollection
+     */
     public function getRouteCollection()
     {
         return $this->collection ??= $this->loader->load($this->resource, $this->options['resource_type']);

diff --git a/src/Symfony/Component/Routing/Tests/Loader/PhpFileLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/PhpFileLoaderTest.php
@@ -312,7 +312,7 @@ public function testImportAttributesWithPsr4Prefix(string $configFile)
             $loader = new PhpFileLoader($locator),
             new Psr4DirectoryLoader($locator),
             new class() extends AnnotationClassLoader {
-                protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, object $annot)
+                protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, object $annot): void
                 {
                     $route->setDefault('_controller', $class->getName().'::'.$method->getName());
                 }
@@ -337,7 +337,7 @@ public function testImportAttributesFromClass()
         new LoaderResolver([
             $loader = new PhpFileLoader(new FileLocator(\dirname(__DIR__).'/Fixtures')),
             new class() extends AnnotationClassLoader {
-                protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, object $annot)
+                protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, object $annot): void
                 {
                     $route->setDefault('_controller', $class->getName().'::'.$method->getName());
                 }

diff --git a/src/Symfony/Component/Routing/Tests/Loader/Psr4DirectoryLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/Psr4DirectoryLoaderTest.php
@@ -106,7 +106,7 @@ private function getLoader(): DelegatingLoader
             new LoaderResolver([
                 new Psr4DirectoryLoader($locator),
                 new class() extends AnnotationClassLoader {
-                    protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, object $annot)
+                    protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, object $annot): void
                     {
                         $route->setDefault('_controller', $class->getName().'::'.$method->getName());
                     }

diff --git a/src/Symfony/Component/Routing/Tests/Loader/XmlFileLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/XmlFileLoaderTest.php
@@ -607,7 +607,7 @@ public function testImportAttributesWithPsr4Prefix(string $configFile)
             $loader = new XmlFileLoader($locator),
             new Psr4DirectoryLoader($locator),
             new class() extends AnnotationClassLoader {
-                protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, object $annot)
+                protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, object $annot): void
                 {
                     $route->setDefault('_controller', $class->getName().'::'.$method->getName());
                 }
@@ -632,7 +632,7 @@ public function testImportAttributesFromClass()
         new LoaderResolver([
             $loader = new XmlFileLoader(new FileLocator(\dirname(__DIR__).'/Fixtures')),
             new class() extends AnnotationClassLoader {
-                protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, object $annot)
+                protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, object $annot): void
                 {
                     $route->setDefault('_controller', $class->getName().'::'.$method->getName());
                 }

diff --git a/src/Symfony/Component/Routing/Tests/Loader/YamlFileLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/YamlFileLoaderTest.php
@@ -473,7 +473,7 @@ public function testImportAttributesWithPsr4Prefix(string $configFile)
             $loader = new YamlFileLoader($locator),
             new Psr4DirectoryLoader($locator),
             new class() extends AnnotationClassLoader {
-                protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, object $annot)
+                protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, object $annot): void
                 {
                     $route->setDefault('_controller', $class->getName().'::'.$method->getName());
                 }
@@ -498,7 +498,7 @@ public function testImportAttributesFromClass()
         new LoaderResolver([
             $loader = new YamlFileLoader(new FileLocator(\dirname(__DIR__).'/Fixtures')),
             new class() extends AnnotationClassLoader {
-                protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, object $annot)
+                protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, object $annot): void
                 {
                     $route->setDefault('_controller', $class->getName().'::'.$method->getName());
                 }

@@ -50,6 +50,8 @@ public function __construct(array $users = [])
     /**
      * Adds a new User to the provider.
      *
+     * @return void
+     *
      * @throws \LogicException
      */
     public function createUser(UserInterface $user)

@@ -108,6 +108,9 @@ public function onKernelFinishRequest(FinishRequestEvent $event)
         }
     }
 
+    /**
+     * @return array
+     */
     public static function getSubscribedEvents()
     {
         return [

@@ -139,12 +139,17 @@ public function __construct(
 
     /**
      * @param array $context
+     *
+     * @return bool
      */
     public function supportsNormalization(mixed $data, string $format = null /* , array $context = [] */)
     {
         return \is_object($data) && !$data instanceof \Traversable;
     }
 
+    /**
+     * @return array|string|int|float|bool|\ArrayObject|null
+     */
     public function normalize(mixed $object, string $format = null, array $context = [])
     {
         if (!isset($context['cache_key'])) {
@@ -226,6 +231,9 @@ public function normalize(mixed $object, string $format = null, array $context =
         return $data;
     }
 
+    /**
+     * @return object
+     */
     protected function instantiateObject(array &$data, string $class, array &$context, \ReflectionClass $reflectionClass, array|bool $allowedAttributes, string $format = null)
     {
         if ($this->classDiscriminatorResolver && $mapping = $this->classDiscriminatorResolver->getMappingForClass($class)) {
@@ -299,12 +307,17 @@ abstract protected function getAttributeValue(object $object, string $attribute,
 
     /**
      * @param array $context
+     *
+     * @return bool
      */
     public function supportsDenormalization(mixed $data, string $type, string $format = null /* , array $context = [] */)
     {
         return class_exists($type) || (interface_exists($type, false) && null !== $this->classDiscriminatorResolver?->getMappingForClass($type));
     }
 
+    /**
+     * @return mixed
+     */
     public function denormalize(mixed $data, string $type, string $format = null, array $context = [])
     {
         if (!isset($context['cache_key'])) {
@@ -408,7 +421,7 @@ public function denormalize(mixed $data, string $type, string $format = null, ar
     }
 
     /**
-     * Sets attribute value.
+     * @return void
      */
     abstract protected function setAttributeValue(object $object, string $attribute, mixed $value, string $format = null, array $context = []);
 

diff --git a/src/Symfony/Component/Translation/Catalogue/AbstractOperation.php b/src/Symfony/Component/Translation/Catalogue/AbstractOperation.php
@@ -183,6 +183,8 @@ public function moveMessagesToIntlDomainsIfPossible(string $batch = self::ALL_BA
      * stores the results.
      *
      * @param string $domain The domain which the operation will be performed for
+     *
+     * @return void
      */
     abstract protected function processDomain(string $domain);
 }
-Original file line number
+Diff line change
@@ Expand Up @@
             return new Route($path, $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
         }
+        /**
+         * @return void
+         */
         abstract protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, object $annot);
         /**
@@ Expand Down @@