Add missing return types to magic methods

wouterj · nicolas-grekas · commit 6b270010c43c · 2023-07-05T11:39:50.000+02:00
diff --git a/.github/expected-missing-return-types.diff b/.github/expected-missing-return-types.diff
diff --git a/.github/patch-types.php b/.github/patch-types.php
@@ -75,7 +75,9 @@ class_exists($class);
         if (
             $method->getReturnType()
             || str_contains($method->getDocComment(), '@return')
-            || str_starts_with($method->getName(), '__')
+            || '__construct' === $method->getName()
+            || '__destruct' === $method->getName()
+            || '__clone' === $method->getName()
             || $method->getDeclaringClass()->getName() !== $class
             || str_contains($method->getDeclaringClass()->getName(), '\\Test\\')
         ) {
diff --git a/src/Symfony/Bridge/Monolog/Handler/ElasticsearchLogstashHandler.php b/src/Symfony/Bridge/Monolog/Handler/ElasticsearchLogstashHandler.php
@@ -154,6 +154,9 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
+    /**
+     * @return void
+     */
     public function __wakeup()
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
diff --git a/src/Symfony/Bundle/SecurityBundle/Debug/WrappedListener.php b/src/Symfony/Bundle/SecurityBundle/Debug/WrappedListener.php
@@ -24,12 +24,15 @@ final class WrappedListener
 {
     use TraceableListenerTrait;
 
+    /**
+     * @param callable(RequestEvent):void $listener
+     */
     public function __construct(callable $listener)
     {
         $this->listener = $listener;
     }
 
-    public function __invoke(RequestEvent $event)
+    public function __invoke(RequestEvent $event): void
     {
         $startTime = microtime(true);
         ($this->listener)($event);
diff --git a/src/Symfony/Bundle/SecurityBundle/Security/LazyFirewallContext.php b/src/Symfony/Bundle/SecurityBundle/Security/LazyFirewallContext.php
@@ -39,7 +39,7 @@ public function getListeners(): iterable
         return [$this];
     }
 
-    public function __invoke(RequestEvent $event)
+    public function __invoke(RequestEvent $event): void
     {
         $listeners = [];
         $request = $event->getRequest();
diff --git a/src/Symfony/Component/Cache/Adapter/TagAwareAdapter.php b/src/Symfony/Component/Cache/Adapter/TagAwareAdapter.php
@@ -295,6 +295,9 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
+    /**
+     * @return void
+     */
     public function __wakeup()
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
diff --git a/src/Symfony/Component/Cache/Messenger/EarlyExpirationDispatcher.php b/src/Symfony/Component/Cache/Messenger/EarlyExpirationDispatcher.php
@@ -34,6 +34,9 @@ public function __construct(MessageBusInterface $bus, ReverseContainer $reverseC
         $this->callbackWrapper = null === $callbackWrapper ? null : $callbackWrapper(...);
     }
 
+    /**
+     * @return mixed
+     */
     public function __invoke(callable $callback, CacheItem $item, bool &$save, AdapterInterface $pool, \Closure $setMetadata, LoggerInterface $logger = null)
     {
         if (!$item->isHit() || null === $message = EarlyExpirationMessage::create($this->reverseContainer, $callback, $item, $pool)) {
diff --git a/src/Symfony/Component/Cache/Messenger/EarlyExpirationHandler.php b/src/Symfony/Component/Cache/Messenger/EarlyExpirationHandler.php
@@ -28,6 +28,9 @@ public function __construct(ReverseContainer $reverseContainer)
         $this->reverseContainer = $reverseContainer;
     }
 
+    /**
+     * @return void
+     */
     public function __invoke(EarlyExpirationMessage $message)
     {
         $item = $message->getItem();
diff --git a/src/Symfony/Component/Cache/Traits/AbstractAdapterTrait.php b/src/Symfony/Component/Cache/Traits/AbstractAdapterTrait.php
@@ -283,6 +283,9 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
+    /**
+     * @return void
+     */
     public function __wakeup()
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
diff --git a/src/Symfony/Component/Cache/Traits/FilesystemCommonTrait.php b/src/Symfony/Component/Cache/Traits/FilesystemCommonTrait.php
@@ -171,6 +171,9 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
+    /**
+     * @return void
+     */
     public function __wakeup()
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
diff --git a/src/Symfony/Component/Cache/Traits/ValueWrapper.php b/src/Symfony/Component/Cache/Traits/ValueWrapper.php
@@ -55,7 +55,7 @@ public function __serialize(): array
         return [$pack => $this->value] + ($this->metadata['tags'] ?? []);
     }
 
-    public function __unserialize(array $data)
+    public function __unserialize(array $data): void
     {
         $pack = array_key_first($data);
         $this->value = $data[$pack];
diff --git a/src/Symfony/Component/Config/Resource/ClassExistenceResource.php b/src/Symfony/Component/Config/Resource/ClassExistenceResource.php
@@ -116,7 +116,7 @@ public function __sleep(): array
     /**
      * @internal
      */
-    public function __wakeup()
+    public function __wakeup(): void
     {
         if (\is_bool($this->exists)) {
             $this->exists = [$this->exists, null];
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/AbstractConfigurator.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/AbstractConfigurator.php
@@ -34,6 +34,9 @@ abstract class AbstractConfigurator
     /** @internal */
     protected Definition|Alias|null $definition = null;
 
+    /**
+     * @return mixed
+     */
     public function __call(string $method, array $args)
     {
         if (method_exists($this, 'set'.$method)) {
@@ -48,6 +51,9 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
+    /**
+     * @return void
+     */
     public function __wakeup()
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
diff --git a/src/Symfony/Component/DependencyInjection/ServiceLocator.php b/src/Symfony/Component/DependencyInjection/ServiceLocator.php
@@ -60,6 +60,9 @@ public function get(string $id): mixed
         }
     }
 
+    /**
+     * @return mixed
+     */
     public function __invoke(string $id)
     {
         return isset($this->factories[$id]) ? $this->get($id) : null;
diff --git a/src/Symfony/Component/ErrorHandler/BufferingLogger.php b/src/Symfony/Component/ErrorHandler/BufferingLogger.php
@@ -40,6 +40,9 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
+    /**
+     * @return void
+     */
     public function __wakeup()
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
diff --git a/src/Symfony/Component/Form/Util/OrderedHashMapIterator.php b/src/Symfony/Component/Form/Util/OrderedHashMapIterator.php
@@ -62,6 +62,9 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
+    /**
+     * @return void
+     */
     public function __wakeup()
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
diff --git a/src/Symfony/Component/HttpClient/Chunk/ErrorChunk.php b/src/Symfony/Component/HttpClient/Chunk/ErrorChunk.php
@@ -98,6 +98,9 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
+    /**
+     * @return void
+     */
     public function __wakeup()
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
diff --git a/src/Symfony/Component/HttpClient/HttplugClient.php b/src/Symfony/Component/HttpClient/HttplugClient.php
@@ -251,7 +251,7 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
-    public function __wakeup()
+    public function __wakeup(): void
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
     }
diff --git a/src/Symfony/Component/HttpClient/Response/AmpResponse.php b/src/Symfony/Component/HttpClient/Response/AmpResponse.php
@@ -144,7 +144,7 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
-    public function __wakeup()
+    public function __wakeup(): void
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
     }
diff --git a/src/Symfony/Component/HttpClient/Response/CommonResponseTrait.php b/src/Symfony/Component/HttpClient/Response/CommonResponseTrait.php
@@ -122,6 +122,9 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
+    /**
+     * @return void
+     */
     public function __wakeup()
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
diff --git a/src/Symfony/Component/HttpClient/Response/TraceableResponse.php b/src/Symfony/Component/HttpClient/Response/TraceableResponse.php
@@ -49,7 +49,7 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
-    public function __wakeup()
+    public function __wakeup(): void
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
     }
diff --git a/src/Symfony/Component/HttpKernel/DataCollector/DataCollector.php b/src/Symfony/Component/HttpKernel/DataCollector/DataCollector.php
@@ -82,6 +82,9 @@ public function __sleep(): array
         return ['data'];
     }
 
+    /**
+     * @return void
+     */
     public function __wakeup()
     {
     }
diff --git a/src/Symfony/Component/HttpKernel/DataCollector/DumpDataCollector.php b/src/Symfony/Component/HttpKernel/DataCollector/DumpDataCollector.php
@@ -167,7 +167,7 @@ public function __sleep(): array
     /**
      * @internal
      */
-    public function __wakeup()
+    public function __wakeup(): void
     {
         parent::__wakeup();
 
diff --git a/src/Symfony/Component/HttpKernel/Kernel.php b/src/Symfony/Component/HttpKernel/Kernel.php
@@ -835,6 +835,9 @@ public function __sleep(): array
         return ['environment', 'debug'];
     }
 
+    /**
+     * @return void
+     */
     public function __wakeup()
     {
         if (\is_object($this->environment) || \is_object($this->debug)) {
diff --git a/src/Symfony/Component/Ldap/Adapter/ExtLdap/Connection.php b/src/Symfony/Component/Ldap/Adapter/ExtLdap/Connection.php
@@ -46,6 +46,9 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
+    /**
+     * @return void
+     */
     public function __wakeup()
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
diff --git a/src/Symfony/Component/Ldap/Adapter/ExtLdap/Query.php b/src/Symfony/Component/Ldap/Adapter/ExtLdap/Query.php
@@ -36,6 +36,9 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
+    /**
+     * @return void
+     */
     public function __wakeup()
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
diff --git a/src/Symfony/Component/Lock/Lock.php b/src/Symfony/Component/Lock/Lock.php
@@ -54,7 +54,7 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
-    public function __wakeup()
+    public function __wakeup(): void
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
     }
diff --git a/src/Symfony/Component/Mailer/Transport/Smtp/SmtpTransport.php b/src/Symfony/Component/Mailer/Transport/Smtp/SmtpTransport.php
@@ -377,6 +377,9 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
+    /**
+     * @return void
+     */
     public function __wakeup()
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
diff --git a/src/Symfony/Component/Messenger/Bridge/AmazonSqs/Transport/Connection.php b/src/Symfony/Component/Messenger/Bridge/AmazonSqs/Transport/Connection.php
@@ -70,6 +70,9 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
+    /**
+     * @return void
+     */
     public function __wakeup()
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
diff --git a/src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/PostgreSqlConnection.php b/src/Symfony/Component/Messenger/Bridge/Doctrine/Transport/PostgreSqlConnection.php
@@ -38,6 +38,9 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
+    /**
+     * @return void
+     */
     public function __wakeup()
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
diff --git a/src/Symfony/Component/Messenger/Handler/RedispatchMessageHandler.php b/src/Symfony/Component/Messenger/Handler/RedispatchMessageHandler.php
@@ -22,7 +22,7 @@ public function __construct(
     ) {
     }
 
-    public function __invoke(RedispatchMessage $message)
+    public function __invoke(RedispatchMessage $message): void
     {
         $this->bus->dispatch($message->envelope, [new TransportNamesStamp($message->transportNames)]);
     }
diff --git a/src/Symfony/Component/Mime/Part/DataPart.php b/src/Symfony/Component/Mime/Part/DataPart.php
@@ -146,6 +146,9 @@ public function __sleep(): array
         return ['_headers', '_parent', 'filename', 'mediaType'];
     }
 
+    /**
+     * @return void
+     */
     public function __wakeup()
     {
         $r = new \ReflectionProperty(AbstractPart::class, 'headers');
diff --git a/src/Symfony/Component/Mime/Part/MessagePart.php b/src/Symfony/Component/Mime/Part/MessagePart.php
@@ -65,7 +65,7 @@ public function __sleep(): array
         return ['message'];
     }
 
-    public function __wakeup()
+    public function __wakeup(): void
     {
         $this->__construct($this->message);
     }
diff --git a/src/Symfony/Component/Mime/Part/TextPart.php b/src/Symfony/Component/Mime/Part/TextPart.php
@@ -236,6 +236,9 @@ public function __sleep(): array
         return ['_headers', 'body', 'charset', 'subtype', 'disposition', 'name', 'encoding'];
     }
 
+    /**
+     * @return void
+     */
     public function __wakeup()
     {
         $r = new \ReflectionProperty(AbstractPart::class, 'headers');
diff --git a/src/Symfony/Component/Process/Pipes/UnixPipes.php b/src/Symfony/Component/Process/Pipes/UnixPipes.php
@@ -40,7 +40,7 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
-    public function __wakeup()
+    public function __wakeup(): void
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
     }
diff --git a/src/Symfony/Component/Process/Pipes/WindowsPipes.php b/src/Symfony/Component/Process/Pipes/WindowsPipes.php
@@ -93,7 +93,7 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
-    public function __wakeup()
+    public function __wakeup(): void
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
     }
diff --git a/src/Symfony/Component/Process/Process.php b/src/Symfony/Component/Process/Process.php
@@ -200,6 +200,9 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
+    /**
+     * @return void
+     */
     public function __wakeup()
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
diff --git a/src/Symfony/Component/Routing/Loader/Configurator/CollectionConfigurator.php b/src/Symfony/Component/Routing/Loader/Configurator/CollectionConfigurator.php
@@ -43,6 +43,9 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
+    /**
+     * @return void
+     */
     public function __wakeup()
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
diff --git a/src/Symfony/Component/Routing/Loader/Configurator/ImportConfigurator.php b/src/Symfony/Component/Routing/Loader/Configurator/ImportConfigurator.php
@@ -35,6 +35,9 @@ public function __sleep(): array
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
+    /**
+     * @return void
+     */
     public function __wakeup()
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
diff --git a/src/Symfony/Component/Security/Http/Authenticator/Debug/TraceableAuthenticator.php b/src/Symfony/Component/Security/Http/Authenticator/Debug/TraceableAuthenticator.php
@@ -97,7 +97,7 @@ public function getAuthenticator(): AuthenticatorInterface
         return $this->authenticator;
     }
 
-    public function __call($method, $args)
+    public function __call($method, $args): mixed
     {
         return $this->authenticator->{$method}(...$args);
     }
diff --git a/src/Symfony/Component/Security/Http/Firewall/AbstractListener.php b/src/Symfony/Component/Security/Http/Firewall/AbstractListener.php
diff --git a/src/Symfony/Component/Semaphore/Semaphore.php b/src/Symfony/Component/Semaphore/Semaphore.php
diff --git a/src/Symfony/Component/String/UnicodeString.php b/src/Symfony/Component/String/UnicodeString.php
diff --git a/src/Symfony/Component/Translation/DataCollectorTranslator.php b/src/Symfony/Component/Translation/DataCollectorTranslator.php
diff --git a/src/Symfony/Component/Translation/LoggingTranslator.php b/src/Symfony/Component/Translation/LoggingTranslator.php
diff --git a/src/Symfony/Component/Validator/Constraint.php b/src/Symfony/Component/Validator/Constraint.php
diff --git a/src/Symfony/Component/Validator/Constraints/File.php b/src/Symfony/Component/Validator/Constraints/File.php
diff --git a/src/Symfony/Component/VarDumper/Cloner/Data.php b/src/Symfony/Component/VarDumper/Cloner/Data.php

Original file line number	Diff line number	Diff line change
`@@ -154,6 +154,9 @@ public function __sleep(): array`
`154`	`154`	`throw new \BadMethodCallException('Cannot serialize '.__CLASS__);`
`155`	`155`	`}`
`156`	`156`
	`157`	`+ /**`
	`158`	`+ * @return void`
	`159`	`+ */`
`157`	`160`	`public function __wakeup()`
`158`	`161`	`{`
`159`	`162`	`throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);`
Original file line number	Diff line number	Diff line change
`@@ -24,12 +24,15 @@ final class WrappedListener`
`24`	`24`	`{`
`25`	`25`	`use TraceableListenerTrait;`
`26`	`26`
	`27`	`+ /**`
	`28`	`+ * @param callable(RequestEvent):void $listener`
	`29`	`+ */`
`27`	`30`	`public function __construct(callable $listener)`
`28`	`31`	`{`
`29`	`32`	`$this->listener = $listener;`
`30`	`33`	`}`
`31`	`34`
`32`		`- public function __invoke(RequestEvent $event)`
	`35`	`+ public function __invoke(RequestEvent $event): void`
`33`	`36`	`{`
`34`	`37`	`$startTime = microtime(true);`
`35`	`38`	`($this->listener)($event);`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public function getListeners(): iterable`
`39`	`39`	`return [$this];`
`40`	`40`	`}`
`41`	`41`
`42`		`- public function __invoke(RequestEvent $event)`
	`42`	`+ public function __invoke(RequestEvent $event): void`
`43`	`43`	`{`
`44`	`44`	`$listeners = [];`
`45`	`45`	`$request = $event->getRequest();`
Original file line number	Diff line number	Diff line change
`@@ -295,6 +295,9 @@ public function __sleep(): array`
`295`	`295`	`throw new \BadMethodCallException('Cannot serialize '.__CLASS__);`
`296`	`296`	`}`
`297`	`297`
	`298`	`+ /**`
	`299`	`+ * @return void`
	`300`	`+ */`
`298`	`301`	`public function __wakeup()`
`299`	`302`	`{`
`300`	`303`	`throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);`
Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,9 @@ public function __construct(MessageBusInterface $bus, ReverseContainer $reverseC`
`34`	`34`	`$this->callbackWrapper = null === $callbackWrapper ? null : $callbackWrapper(...);`
`35`	`35`	`}`
`36`	`36`
	`37`	`+ /**`
	`38`	`+ * @return mixed`
	`39`	`+ */`
`37`	`40`	`public function __invoke(callable $callback, CacheItem $item, bool &$save, AdapterInterface $pool, \Closure $setMetadata, LoggerInterface $logger = null)`
`38`	`41`	`{`
`39`	`42`	`if (!$item->isHit() \|\| null === $message = EarlyExpirationMessage::create($this->reverseContainer, $callback, $item, $pool)) {`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,9 @@ public function __construct(ReverseContainer $reverseContainer)`
`28`	`28`	`$this->reverseContainer = $reverseContainer;`
`29`	`29`	`}`
`30`	`30`
	`31`	`+ /**`
	`32`	`+ * @return void`
	`33`	`+ */`
`31`	`34`	`public function __invoke(EarlyExpirationMessage $message)`
`32`	`35`	`{`
`33`	`36`	`$item = $message->getItem();`
Original file line number	Diff line number	Diff line change
`@@ -283,6 +283,9 @@ public function __sleep(): array`
`283`	`283`	`throw new \BadMethodCallException('Cannot serialize '.__CLASS__);`
`284`	`284`	`}`
`285`	`285`
	`286`	`+ /**`
	`287`	`+ * @return void`
	`288`	`+ */`
`286`	`289`	`public function __wakeup()`
`287`	`290`	`{`
`288`	`291`	`throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);`
Original file line number	Diff line number	Diff line change
`@@ -171,6 +171,9 @@ public function __sleep(): array`
`171`	`171`	`throw new \BadMethodCallException('Cannot serialize '.__CLASS__);`
`172`	`172`	`}`
`173`	`173`
	`174`	`+ /**`
	`175`	`+ * @return void`
	`176`	`+ */`
`174`	`177`	`public function __wakeup()`
`175`	`178`	`{`
`176`	`179`	`throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);`