Deprecate overring the __sleep method of ClassMetadata or PersistentCollection

Author: GromNaN

src/Mapping/ClassMetadata.php

@@ -34,6 +34,7 @@
 use ProxyManager\Proxy\GhostObjectInterface;
 use ReflectionClass;
 use ReflectionEnum;
+use ReflectionMethod;
 use ReflectionNamedType;
 use ReflectionProperty;
 use Symfony\Component\Uid\UuidV1;
@@ -2640,12 +2641,36 @@ public function mapField(array $mapping): array
      * That means any metadata properties that are not set or empty or simply have
      * their default value are NOT serialized.
      *
-     * Parts that are also NOT serialized because they cannot be properly unserialized:
-     *      - reflClass (ReflectionClass)
-     *      - reflFields (ReflectionProperty array)
-     *      - propertyAccessors (ReflectionProperty array)
+     *  Parts that are also NOT serialized because they cannot be properly unserialized:
+     *       - reflClass (ReflectionClass)
+     *       - reflFields (ReflectionProperty array)
+     *       - propertyAccessors (ReflectionProperty array)
      *
-     * @return array The names of all the fields that should be serialized.
+     * @return array<string, mixed> The serialized data.
+     */
+    public function __serialize(): array
+    {
+        if (new ReflectionMethod($this, '__sleep')->getDeclaringClass() !== self::class) {
+            trigger_deprecation(
+                'doctrine/mongodb-odm',
+                '2.16',
+                'The method __sleep() is deprecated. Implement and use %s() instead.',
+                __METHOD__,
+            );
+        }
+
+        $data = [];
+        foreach ($this->__sleep() as $field) {
+            $data[$field] = $this->$field;
+        }
+
+        return $data;
+    }
+
+    /**
+     * @deprecated
+     *
+     * @return list<string> The names of all the fields that should be serialized.
      */
     public function __sleep()
     {
@@ -2700,7 +2725,7 @@ public function __sleep()
             $serialized[] = 'isQueryResultDocument';
         }
 
-        if ($this->isView()) {
+        if ($this->isView) {
             $serialized[] = 'isView';
             $serialized[] = 'rootClass';
         }
@@ -2745,8 +2770,20 @@ public function __sleep()
     }
 
     /**
-     * Restores some state that cannot be serialized/unserialized.
+     * Restores the serialized values and some state that cannot be serialized/unserialized.
+     *
+     * @param array<string, mixed> $data The serialized data.
      */
+    public function __unserialize(array $data): void
+    {
+        foreach ($data as $field => $value) {
+            $this->$field = $value;
+        }
+
+        $this->__wakeup();
+    }
+
+    /** @deprecated */
     public function __wakeup(): void
     {
         // Restore ReflectionClass and properties

src/PersistentCollection/PersistentCollectionTrait.php

@@ -509,6 +509,23 @@ public function slice($offset, $length = null)
      * Called by PHP when this collection is serialized. Ensures that the
      * internal state of the collection can be reproduced after serialization
      *
+     * @return array<string, mixed>
+     */
+    public function __serialize(): array
+    {
+        return [
+            'coll' => $this->coll,
+            'initialized' => $this->initialized,
+            'mongoData' => $this->mongoData,
+            'snapshot' => $this->snapshot,
+            'isDirty' => $this->isDirty,
+            'hints' => $this->hints,
+        ];
+    }
+
+    /**
+     * @deprecated Implement and use __serialize() instead.
+     *
      * @return string[]
      */
     public function __sleep()