[6.x] Serialization of models on PHP 7.4 with compatibility with PHP 7.3 and below

src/Illuminate/Queue/SerializesModels.php

@@ -2,7 +2,6 @@
 
 namespace Illuminate\Queue;
 
-use Illuminate\Contracts\Database\ModelIdentifier;
 use ReflectionClass;
 use ReflectionProperty;
 
@@ -11,67 +10,109 @@ trait SerializesModels
     use SerializesAndRestoresModelIdentifiers;
 
     /**
-     * The list of serialized model identifiers.
+     * Prepare the instance for serialization.
      *
-     * @var array
+     * @return array
      */
-    protected $modelIdentifiers = [];
+    public function __sleep()
+    {
+        $properties = (new ReflectionClass($this))->getProperties();
+
+        foreach ($properties as $property) {
+            $property->setValue($this, $this->getSerializedPropertyValue(
+                $this->getPropertyValue($property)
+            ));
+        }
+
+        return array_values(array_filter(array_map(function ($p) {
+            return $p->isStatic() ? null : $p->getName();
+        }, $properties)));
+    }
 
     /**
-     * Prepare the instance for serialization.
+     * Restore the model after serialization.
+     *
+     * @return void
+     */
+    public function __wakeup()
+    {
+        foreach ((new ReflectionClass($this))->getProperties() as $property) {
+            if ($property->isStatic()) {
+                continue;
+            }
+
+            $property->setValue($this, $this->getRestoredPropertyValue(
+                $this->getPropertyValue($property)
+            ));
+        }
+    }
+
+    /**
+     * Prepare the instance values for serialization.
      *
      * @return array
      */
-    public function __sleep()
+    public function __serialize()
     {
+        $values = [];
+
         $properties = (new ReflectionClass($this))->getProperties();
 
+        $class = get_class($this);
+
         foreach ($properties as $property) {
-            if ($property->getName() === 'modelIdentifiers') {
+            if ($property->isStatic()) {
                 continue;
             }
 
-            $serializedValue = $this->getSerializedPropertyValue(
-                $value = $this->getPropertyValue($property)
-            );
+            $name = $property->getName();
 
-            if ($serializedValue instanceof ModelIdentifier) {
-                $this->modelIdentifiers[$property->getName()] = $serializedValue;
-
-                // Empty instance of the model or collection to support typed properties...
-                $property->setValue($this, new $value);
-            } else {
-                $property->setValue($this, $value);
+            if ($property->isPrivate()) {
+                $name = "\0{$class}\0{$name}";
+            } elseif ($property->isProtected()) {
+                $name = "\0*\0{$name}";
             }
+
+            $values[$name] = $this->getSerializedPropertyValue($this->getPropertyValue($property));
         }
 
-        return array_values(array_filter(array_map(function ($p) {
-            return $p->isStatic() ? null : $p->getName();
-        }, $properties)));
+        return $values;
     }
 
     /**
      * Restore the model after serialization.
      *
-     * @return void
+     * @param  array  $values
+     * @return array
      */
-    public function __wakeup()
+    public function __unserialize(array $values)
     {
-        foreach ((new ReflectionClass($this))->getProperties() as $property) {
-            if ($property->isStatic() || $property->getName() === 'modelIdentifiers') {
+        $properties = (new ReflectionClass($this))->getProperties();
+
+        $class = get_class($this);
+
+        foreach ($properties as $property) {
+            if ($property->isStatic()) {
                 continue;
             }
 
-            if (isset($this->modelIdentifiers[$property->getName()])) {
-                $value = $this->modelIdentifiers[$property->getName()];
-            } else {
-                $value = $this->getPropertyValue($property);
+            $name = $property->getName();
+
+            if ($property->isPrivate()) {
+                $name = "\0{$class}\0{$name}";
+            } elseif ($property->isProtected()) {
+                $name = "\0*\0{$name}";
             }
 
-            $property->setValue($this, $this->getRestoredPropertyValue(
-                $value
-            ));
+            if (! array_key_exists($name, $values)) {
+                continue;
+            }
+
+            $property->setAccessible(true);
+            $property->setValue($this, $this->getRestoredPropertyValue($values[$name]));
         }
+
+        return $values;
     }
 
     /**

tests/Integration/Queue/ModelSerializationTest.php

@@ -292,8 +292,8 @@ public function testItSerializesTypedProperties()
 
         $this->assertSame('testbench', $unSerialized->user->getConnectionName());
         $this->assertSame('[email protected]', $unSerialized->user->email);
-        $this->assertSame(5, $unSerialized->id);
-        $this->assertSame(['James', 'Taylor', 'Mohamed'], $unSerialized->names);
+        $this->assertSame(5, $unSerialized->getId());
+        $this->assertSame(['James', 'Taylor', 'Mohamed'], $unSerialized->getNames());
 
         $serialized = serialize(new TypedPropertyCollectionTestClass(ModelSerializationTestUser::on('testbench')->get()));
 
@@ -304,6 +304,19 @@ public function testItSerializesTypedProperties()
         $this->assertSame('testbench', $unSerialized->users[1]->getConnectionName());
         $this->assertSame('[email protected]', $unSerialized->users[1]->email);
     }
+
+    public function test_model_serialization_structure()
+    {
+        $user = ModelSerializationTestUser::create([
+            'email' => '[email protected]',
+        ]);
+
+        $serialized = serialize(new ModelSerializationParentAccessibleTestClass($user, $user, $user));
+
+        $this->assertEquals(
+            'O:78:"Illuminate\\Tests\\Integration\\Queue\\ModelSerializationParentAccessibleTestClass":2:{s:4:"user";O:45:"Illuminate\\Contracts\\Database\\ModelIdentifier":4:{s:5:"class";s:61:"Illuminate\\Tests\\Integration\\Queue\\ModelSerializationTestUser";s:2:"id";i:1;s:9:"relations";a:0:{}s:10:"connection";s:9:"testbench";}s:8:"'."\0".'*'."\0".'user2";O:45:"Illuminate\\Contracts\\Database\\ModelIdentifier":4:{s:5:"class";s:61:"Illuminate\\Tests\\Integration\\Queue\\ModelSerializationTestUser";s:2:"id";i:1;s:9:"relations";a:0:{}s:10:"connection";s:9:"testbench";}}', $serialized
+        );
+    }
 }
 
 class ModelSerializationTestUser extends Model
@@ -420,6 +433,27 @@ public function __construct($user)
     }
 }
 
+class ModelSerializationAccessibleTestClass
+{
+    use SerializesModels;
+
+    public $user;
+    protected $user2;
+    private $user3;
+
+    public function __construct($user, $user2, $user3)
+    {
+        $this->user = $user;
+        $this->user2 = $user2;
+        $this->user3 = $user3;
+    }
+}
+
+class ModelSerializationParentAccessibleTestClass extends ModelSerializationAccessibleTestClass
+{
+    //
+}
+
 class ModelRelationSerializationTestClass
 {
     use SerializesModels;

tests/Integration/Queue/typed-properties.php

@@ -11,16 +11,32 @@ class TypedPropertyTestClass
 
     public ModelSerializationTestUser $user;
 
-    public int $id;
+    protected int $id;
 
-    public array $names;
+    private array $names;
 
     public function __construct(ModelSerializationTestUser $user, int $id, array $names)
     {
         $this->user = $user;
         $this->id = $id;
         $this->names = $names;
     }
+
+    /**
+     * @return int
+     */
+    public function getId()
+    {
+        return $this->id;
+    }
+
+    /**
+     * @return array
+     */
+    public function getNames()
+    {
+        return $this->names;
+    }
 }
 
 class TypedPropertyCollectionTestClass