Merge pull request #1791 from hydephp/automatic-serialization-method

Update the `Serializable` trait to provide a default automatic `toArray` method

RELEASE_NOTES.md

@@ -13,7 +13,7 @@ This serves two purposes:
 - Updated the `HydeKernel` array representation to include the Hyde version in https://github.com/hydephp/develop/pull/1786
 
 ### Changed
-- for changes in existing functionality.
+- Updated the `Serializable` trait to provide a default automatic `toArray` method in https://github.com/hydephp/develop/pull/1791
 
 ### Deprecated
 - for soon-to-be removed features.

packages/framework/src/Support/Concerns/Serializable.php

@@ -14,8 +14,13 @@
  */
 trait Serializable
 {
-    /** @inheritDoc */
-    abstract public function toArray(): array;
+    /** Default implementation to dynamically serialize all public properties. Can be overridden for increased control. */
+    public function toArray(): array
+    {
+        // Calling the function from a different scope means we only get the public properties.
+
+        return get_object_vars(...)->__invoke($this);
+    }
 
     /** Recursively serialize Arrayables */
     public function arraySerialize(): array

packages/framework/tests/Unit/SerializableTest.php

@@ -53,6 +53,15 @@ public function testToJsonWithArrayable()
     {
         $this->assertSame('{"foo":"bar","arrayable":{"foo":"bar"}}', (new SerializableTestClassWithArrayable)->toJson());
     }
+
+    public function testAutomaticallySerialization()
+    {
+        $this->assertSame([
+            'foo' => 'foo',
+            'bar' => 'bar',
+            'baz' => ['baz' => 'baz'],
+        ], (new AutomaticallySerializableTestClass)->toArray());
+    }
 }
 
 class SerializableTestClass implements SerializableContract
@@ -82,3 +91,29 @@ public function toArray(): array
         return ['foo' => 'bar'];
     }
 }
+
+class AutomaticallySerializableTestClass implements SerializableContract
+{
+    use Serializable;
+
+    public string $foo;
+    public string $bar;
+    public array $baz;
+
+    public string $uninitialized;
+
+    protected string $hidden;
+    private string $private;
+
+    public static string $static;
+
+    public function __construct()
+    {
+        $this->foo = 'foo';
+        $this->bar = 'bar';
+        $this->baz = ['baz' => 'baz'];
+        $this->hidden = 'hidden';
+        $this->private = 'private';
+        static::$static = 'static';
+    }
+}