update the serialization format of entities

The unserialize method is backward compatible and should still work with data serialized before the switch to the new format.

You may want to extend the format to your needs in your childclasses `__serialize` and `__unserialize` methods. Don't forget to call the parent methods though.

Author: tflori

src/Entity.php

@@ -665,15 +665,6 @@ public function serialize()
         return serialize($this->__serialize());
     }
 
-    public function __serialize(): array
-    {
-        return [
-            $this->data,
-            $this->relatedObjects,
-            $this->exists,
-        ];
-    }
-
     /**
      * Constructs the object
      *
@@ -682,15 +673,30 @@ public function __serialize(): array
      */
     public function unserialize($serialized)
     {
-        static::bootIfNotBooted();
-        $data = unserialize($serialized);
-        $this->__unserialize($data);
+        $this->__unserialize(unserialize($serialized));
+    }
+
+    public function __serialize()
+    {
+        return [
+            'data' => $this->data,
+            'related' => $this->relatedObjects,
+            'exists' => $this->exists
+        ];
     }
 
-    public function __unserialize(array $data): void
+    public function __unserialize($data)
     {
         static::bootIfNotBooted();
-        list($this->data, $this->relatedObjects, $this->exists) = $data;
+        // backward compatibility
+        if (array_keys($data) === range(0, count($data) - 1)) {
+            list($this->data, $this->relatedObjects, $this->exists) = $data;
+        } else {
+            $this->data = isset($data['data']) ? $data['data'] : [];
+            $this->relatedObjects = isset($data['related']) ? $data['related'] : [];
+            $this->exists = isset($data['exists']) ? $data['exists'] : false;
+        }
+
         $this->entityManager = EM::getInstance(static::class);
         $this->onInit(false);
     }

tests/Entity/DataTest.php

@@ -348,7 +348,11 @@ public function serialization()
 
         $serialized = $entity->serialize();
 
-        self::assertSame(serialize([['foo' => 'bar'], [], true]), $serialized);
+        self::assertSame(serialize([
+            'data' => ['foo' => 'bar'],
+            'related' => [],
+            'exists' => true
+        ]), $serialized);
     }
 
     /** @test */
@@ -362,6 +366,18 @@ public function deserialization()
         self::assertSame('bar', $entity->foo);
     }
 
+    /** @test */
+    public function deserializationWithOldFormat()
+    {
+        $serialized = 'C:35:"ORM\Test\Entity\Examples\StudlyCaps":54:' .
+            '{a:3:{i:0;a:1:{s:3:"foo";s:3:"bar";}i:1;a:0:{}i:2;b:0;}}';
+
+        $entity = unserialize($serialized);
+
+        self::assertInstanceOf(StudlyCaps::class, $entity);
+        self::assertSame('bar', $entity->foo);
+    }
+
     /** @test */
     public function unserializeCallsOnInit()
     {