bug symfony#61727 Replace __sleep/wakeup() by __(un)serialize() for throwing and internal usages (nicolas-grekas)

This PR was merged into the 6.4 branch.

Discussion
----------

 Replace __sleep/wakeup() by __(un)serialize() for throwing and internal usages

| Q             | A
| ------------- | ---
| Branch?       | 6.4
| Bug fix?      | yes
| New feature?  | no
| Deprecations? | no
| Issues        | -
| License       | MIT

This PR replaces `__sleep`/`wakeup()` by `__(un)serialize()`, for throwing and internal usages.

This follows the merge of php/php-src#19435

While this change on 8.5 might be reverted (see https://wiki.php.net/rfc/soft-deprecate-sleep-wakeup), we can still remove all those cases.

This DOES NOT replace all use cases of `__sleep`/`wakeup()`. We did so already on branch 7.4, but doing it on branch 6.4 is another story. This would basically be way to risky IMHO, with a bunch of non-trivial code to add just to fix the deprecation.

My recommendation for those remaining use cases is to ignore the deprecation. By the time ppl will move to PHP 8.5, they will also move away from Symfony 6.4

I'll submit another PR to the phpunit-bridge for that.

For the record, here is the list of files/classes that cannot be "just" migrated to `__(un)serialize()`
(I'll let the reader wonder about how they could be - and compare their ideas to what we did in 7.4):
- src/Symfony/Component/HttpKernel/Profiler/Profile.php
- src/Symfony/Component/HttpKernel/DataCollector/DataCollector.php
- src/Symfony/Component/HttpKernel/Kernel.php
- src/Symfony/Component/String/AbstractString.php
- src/Symfony/Component/String/LazyString.php
- src/Symfony/Component/Mime/Part/SMimePart.php
- src/Symfony/Component/Mime/Part/TextPart.php
- src/Symfony/Component/Mime/Part/DataPart.php
- src/Symfony/Component/Validator/Constraint.php
- src/Symfony/Component/Validator/Mapping/GenericMetadata.php
- src/Symfony/Component/Validator/Mapping/MemberMetadata.php
- src/Symfony/Component/Validator/Mapping/ClassMetadata.php
- src/Symfony/Component/Serializer/Mapping/AttributeMetadata.php
- src/Symfony/Component/Serializer/Mapping/ClassMetadata.php

Commits
-------

ef4e3d6 Replace __sleep/wakeup() by __(un)serialize() for throwing and internal usages

Author: nicolas-grekas

.github/expected-missing-return-types.diff

@@ -149,15 +149,12 @@ private function sendToElasticsearch(array $records): void
         $this->wait(false);
     }
 
-    public function __sleep(): array
+    public function __serialize(): array
     {
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
-    /**
-     * @return void
-     */
-    public function __wakeup()
+    public function __unserialize(array $data): void
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
     }

src/Symfony/Bridge/Monolog/Handler/ElasticsearchLogstashHandler.php

@@ -93,12 +93,12 @@ public function __construct(array $mockedNamespaces = [])
         }
     }
 
-    public function __sleep()
+    public function __serialize(): array
     {
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
-    public function __wakeup()
+    public function __unserialize(array $data): void
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
     }

src/Symfony/Bridge/PhpUnit/Legacy/SymfonyTestsListenerTrait.php

@@ -89,14 +89,16 @@ protected function build(ContainerBuilder $container): void
         $container->registerExtension(new TestDumpExtension());
     }
 
-    public function __sleep(): array
+    public function __serialize(): array
     {
-        return ['varDir', 'testCase', 'rootConfig', 'environment', 'debug'];
+        return [$this->varDir, $this->testCase, $this->rootConfig, $this->environment, $this->debug];
     }
 
-    public function __wakeup(): void
+    public function __unserialize(array $data): void
     {
-        foreach ($this as $k => $v) {
+        [$this->varDir, $this->testCase, $this->rootConfig, $this->environment, $this->debug] = $data;
+
+        foreach ($this as $v) {
             if (\is_object($v)) {
                 throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
             }

src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/AppKernel.php

@@ -63,12 +63,12 @@ public function getLogDir(): string
         return $this->cacheDir;
     }
 
-    public function __sleep(): array
+    public function __serialize(): array
     {
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
-    public function __wakeup(): void
+    public function __unserialize(array $data): void
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
     }

src/Symfony/Bundle/FrameworkBundle/Tests/Kernel/ConcreteMicroKernel.php

@@ -64,12 +64,12 @@ public function getProjectDir(): string
         return \dirname((new \ReflectionObject($this))->getFileName(), 2);
     }
 
-    public function __sleep(): array
+    public function __serialize(): array
     {
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
-    public function __wakeup(): void
+    public function __unserialize(array $data): void
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
     }

src/Symfony/Bundle/FrameworkBundle/Tests/Kernel/flex-style/src/FlexStyleMicroKernel.php

@@ -294,15 +294,12 @@ public function reset()
         $this->tags instanceof ResettableInterface && $this->tags->reset();
     }
 
-    public function __sleep(): array
+    public function __serialize(): array
     {
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
-    /**
-     * @return void
-     */
-    public function __wakeup()
+    public function __unserialize(array $data): void
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
     }

src/Symfony/Component/Cache/Adapter/TagAwareAdapter.php

@@ -373,7 +373,7 @@ public function testErrorsDontInvalidate()
 
 class NotUnserializable
 {
-    public function __wakeup()
+    public function __unserialize(array $data): void
     {
         throw new \Exception(__CLASS__);
     }

src/Symfony/Component/Cache/Tests/Adapter/AdapterTestCase.php

@@ -176,7 +176,7 @@ protected function isPruned(CacheInterface $cache, string $name): bool
 
 class NotUnserializable
 {
-    public function __wakeup()
+    public function __unserialize(array $data): void
     {
         throw new \Exception(__CLASS__);
     }

src/Symfony/Component/Cache/Tests/Psr16CacheTest.php

@@ -276,15 +276,12 @@ public function reset(): void
         $this->ids = [];
     }
 
-    public function __sleep(): array
+    public function __serialize(): array
     {
         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
     }
 
-    /**
-     * @return void
-     */
-    public function __wakeup()
+    public function __unserialize(array $data): void
     {
         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
     }