Replace __sleep/__wakeup with __serialize/__unserialize

https://wiki.php.net/rfc/soft-deprecate-sleep-wakeup

Author: GromNaN

src/Mapping/ClassMetadata.php

@@ -2460,110 +2460,114 @@ public function mapField(array $mapping): array
      *      - reflClass (ReflectionClass)
      *      - propertyAccessors (ReflectionProperty array)
      *
-     * @return array The names of all the fields that should be serialized.
-     */
-    public function __sleep(): array
-    {
-        // This metadata is always serialized/cached.
-        $serialized = [
-            'fieldMappings',
-            'associationMappings',
-            'identifier',
-            'name',
-            'db',
-            'collection',
-            'readPreference',
-            'readPreferenceTags',
-            'writeConcern',
-            'rootDocumentName',
-            'generatorType',
-            'generatorOptions',
-            'idGenerator',
-            'indexes',
-            'shardKey',
-            'timeSeriesOptions',
+     * @return array<string, mixed>
+     */
+    public function __serialize(): array
+    {
+        $data = [
+            'fieldMappings' => $this->fieldMappings,
+            'associationMappings' => $this->associationMappings,
+            'identifier' => $this->identifier,
+            'name' => $this->name,
+            'db' => $this->db,
+            'collection' => $this->collection,
+            'readPreference' => $this->readPreference,
+            'readPreferenceTags' => $this->readPreferenceTags,
+            'writeConcern' => $this->writeConcern,
+            'rootDocumentName' => $this->rootDocumentName,
+            'generatorType' => $this->generatorType,
+            'generatorOptions' => $this->generatorOptions,
+            'idGenerator' => $this->idGenerator,
+            'indexes' => $this->indexes,
+            'shardKey' => $this->shardKey,
+            'timeSeriesOptions' => $this->timeSeriesOptions,
         ];
 
-        // The rest of the metadata is only serialized if necessary.
         if ($this->changeTrackingPolicy !== self::CHANGETRACKING_DEFERRED_IMPLICIT) {
-            $serialized[] = 'changeTrackingPolicy';
+            $data['changeTrackingPolicy'] = $this->changeTrackingPolicy;
         }
 
         if ($this->customRepositoryClassName) {
-            $serialized[] = 'customRepositoryClassName';
+            $data['customRepositoryClassName'] = $this->customRepositoryClassName;
         }
 
         if ($this->inheritanceType !== self::INHERITANCE_TYPE_NONE || $this->discriminatorField !== null) {
-            $serialized[] = 'inheritanceType';
-            $serialized[] = 'discriminatorField';
-            $serialized[] = 'discriminatorValue';
-            $serialized[] = 'discriminatorMap';
-            $serialized[] = 'defaultDiscriminatorValue';
-            $serialized[] = 'parentClasses';
-            $serialized[] = 'subClasses';
+            $data['inheritanceType']           = $this->inheritanceType;
+            $data['discriminatorField']        = $this->discriminatorField;
+            $data['discriminatorValue']        = $this->discriminatorValue;
+            $data['discriminatorMap']          = $this->discriminatorMap;
+            $data['defaultDiscriminatorValue'] = $this->defaultDiscriminatorValue;
+            $data['parentClasses']             = $this->parentClasses;
+            $data['subClasses']                = $this->subClasses;
         }
 
         if ($this->isMappedSuperclass) {
-            $serialized[] = 'isMappedSuperclass';
+            $data['isMappedSuperclass'] = $this->isMappedSuperclass;
         }
 
         if ($this->isEmbeddedDocument) {
-            $serialized[] = 'isEmbeddedDocument';
+            $data['isEmbeddedDocument'] = $this->isEmbeddedDocument;
         }
 
         if ($this->isQueryResultDocument) {
-            $serialized[] = 'isQueryResultDocument';
+            $data['isQueryResultDocument'] = $this->isQueryResultDocument;
         }
 
-        if ($this->isView()) {
-            $serialized[] = 'isView';
-            $serialized[] = 'rootClass';
+        if ($this->isView) {
+            $data['isView']    = $this->isView;
+            $data['rootClass'] = $this->rootClass;
         }
 
         if ($this->isFile) {
-            $serialized[] = 'isFile';
-            $serialized[] = 'bucketName';
-            $serialized[] = 'chunkSizeBytes';
+            $data['isFile']         = $this->isFile;
+            $data['bucketName']     = $this->bucketName;
+            $data['chunkSizeBytes'] = $this->chunkSizeBytes;
         }
 
         if ($this->isVersioned) {
-            $serialized[] = 'isVersioned';
-            $serialized[] = 'versionField';
+            $data['isVersioned']  = $this->isVersioned;
+            $data['versionField'] = $this->versionField;
         }
 
         if ($this->isLockable) {
-            $serialized[] = 'isLockable';
-            $serialized[] = 'lockField';
+            $data['isLockable'] = $this->isLockable;
+            $data['lockField']  = $this->lockField;
         }
 
         if ($this->lifecycleCallbacks) {
-            $serialized[] = 'lifecycleCallbacks';
+            $data['lifecycleCallbacks'] = $this->lifecycleCallbacks;
         }
 
         if ($this->collectionCapped) {
-            $serialized[] = 'collectionCapped';
-            $serialized[] = 'collectionSize';
-            $serialized[] = 'collectionMax';
+            $data['collectionCapped'] = $this->collectionCapped;
+            $data['collectionSize']   = $this->collectionSize;
+            $data['collectionMax']    = $this->collectionMax;
         }
 
         if ($this->isReadOnly) {
-            $serialized[] = 'isReadOnly';
+            $data['isReadOnly'] = $this->isReadOnly;
         }
 
         if ($this->validator !== null) {
-            $serialized[] = 'validator';
-            $serialized[] = 'validationAction';
-            $serialized[] = 'validationLevel';
+            $data['validator']        = $this->validator;
+            $data['validationAction'] = $this->validationAction;
+            $data['validationLevel']  = $this->validationLevel;
         }
 
-        return $serialized;
+        return $data;
     }
 
     /**
-     * Restores some state that cannot be serialized/unserialized.
+     * Restores state after unserialization.
+     *
+     * @param array<string, mixed> $data
      */
-    public function __wakeup(): void
+    public function __unserialize(array $data): void
     {
+        foreach ($data as $property => $value) {
+            $this->$property = $value;
+        }
+
         // Restore ReflectionClass and properties
         $this->reflClass    = new ReflectionClass($this->name);
         $this->instantiator = new Instantiator();

src/PersistentCollection/PersistentCollectionTrait.php

@@ -540,11 +540,18 @@ public function slice(int $offset, int|null $length = null): array
      * Called by PHP when this collection is serialized. Ensures that the
      * internal state of the collection can be reproduced after serialization
      *
-     * @return string[]
+     * @return array<string, mixed>
      */
-    public function __sleep(): array
-    {
-        return ['coll', 'initialized', 'mongoData', 'snapshot', 'isDirty', 'hints'];
+    public function __serialize(): array
+    {
+        return [
+            'coll' => $this->coll,
+            'initialized' => $this->initialized,
+            'mongoData' => $this->mongoData,
+            'snapshot' => $this->snapshot,
+            'isDirty' => $this->isDirty,
+            'hints' => $this->hints,
+        ];
     }
 
     /* ArrayAccess implementation */

src/Tools/Console/Command/GeneratePersistentCollectionsCommand.php

@@ -6,6 +6,7 @@
 
 use Doctrine\ODM\MongoDB\Tools\Console\MetadataFilter;
 use InvalidArgumentException;
+use LogicException;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -19,6 +20,7 @@
 use function is_array;
 use function is_dir;
 use function is_writable;
+use function method_exists;
 use function mkdir;
 use function realpath;
 use function sprintf;
@@ -103,6 +105,14 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                         continue;
                     }
 
+                    if (method_exists($mapping['collectionClass'], '__sleep')) {
+                        throw new LogicException(sprintf(
+                            'Persistent collection class "%s" cannot implement the __sleep() method ' .
+                            'because it is deprecated in PHP. Implement __serialize() method instead.',
+                            $mapping['collectionClass']
+                        ));
+                    }
+
                     $generated[$mapping['collectionClass']] = true;
                     $output->write(
                         sprintf('Generating class for "<info>%s</info>"', $mapping['collectionClass']) . PHP_EOL