[8.x] ArrayObject + Collection Custom Casts

src/Illuminate/Database/Eloquent/Casts/ArrayObject.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Illuminate\Database\Eloquent\Casts;
+
+use ArrayObject as BaseArrayObject;
+use Illuminate\Contracts\Support\Arrayable;
+use JsonSerializable;
+
+class ArrayObject extends BaseArrayObject implements Arrayable, JsonSerializable
+{
+    /**
+     * Get a collection containing the underlying array.
+     *
+     * @return \Illuminate\Support\Collection
+     */
+    public function collect()
+    {
+        return collect($this->getArrayCopy());
+    }
+
+    /**
+     * Get the instance as an array.
+     *
+     * @return array
+     */
+    public function toArray()
+    {
+        return $this->getArrayCopy();
+    }
+
+    /**
+     * Get the array that should be JSON serialized.
+     *
+     * @return array
+     */
+    public function jsonSerialize()
+    {
+        return $this->getArrayCopy();
+    }
+}

src/Illuminate/Database/Eloquent/Casts/AsArrayObject.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Illuminate\Database\Eloquent\Casts;
+
+use Illuminate\Contracts\Database\Eloquent\Castable;
+use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
+
+class AsArrayObject implements Castable
+{
+    /**
+     * Get the caster class to use when casting from / to this cast target.
+     *
+     * @param  array  $arguments
+     * @return object|string
+     */
+    public static function castUsing(array $arguments)
+    {
+        return new class implements CastsAttributes {
+            public function get($model, $key, $value, $attributes)
+            {
+                return new ArrayObject(json_decode($attributes[$key], true));
+            }
+
+            public function set($model, $key, $value, $attributes)
+            {
+                return [$key => json_encode($value)];
+            }
+
+            public function serialize($model, string $key, $value, array $attributes)
+            {
+                return $value->getArrayCopy();
+            }
+        };
+    }
+}

src/Illuminate/Database/Eloquent/Casts/AsCollection.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Illuminate\Database\Eloquent\Casts;
+
+use Illuminate\Contracts\Database\Eloquent\Castable;
+use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
+use Illuminate\Support\Collection;
+
+class AsCollection implements Castable
+{
+    /**
+     * Get the caster class to use when casting from / to this cast target.
+     *
+     * @param  array  $arguments
+     * @return object|string
+     */
+    public static function castUsing(array $arguments)
+    {
+        return new class implements CastsAttributes {
+            public function get($model, $key, $value, $attributes)
+            {
+                return new Collection(json_decode($attributes[$key], true));
+            }
+
+            public function set($model, $key, $value, $attributes)
+            {
+                return [$key => json_encode($value)];
+            }
+        };
+    }
+}

src/Illuminate/Database/Eloquent/Casts/AsEncryptedArrayObject.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Illuminate\Database\Eloquent\Casts;
+
+use Illuminate\Contracts\Database\Eloquent\Castable;
+use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
+use Illuminate\Support\Facades\Crypt;
+
+class AsEncryptedArrayObject implements Castable
+{
+    /**
+     * Get the caster class to use when casting from / to this cast target.
+     *
+     * @param  array  $arguments
+     * @return object|string
+     */
+    public static function castUsing(array $arguments)
+    {
+        return new class implements CastsAttributes {
+            public function get($model, $key, $value, $attributes)
+            {
+                return new ArrayObject(json_decode(Crypt::decryptString($attributes[$key]), true));
+            }
+
+            public function set($model, $key, $value, $attributes)
+            {
+                return [$key => Crypt::encryptString(json_encode($value))];
+            }
+
+            public function serialize($model, string $key, $value, array $attributes)
+            {
+                return $value->getArrayCopy();
+            }
+        };
+    }
+}

src/Illuminate/Database/Eloquent/Casts/AsEncryptedCollection.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Illuminate\Database\Eloquent\Casts;
+
+use Illuminate\Contracts\Database\Eloquent\Castable;
+use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Crypt;
+
+class AsEncryptedCollection implements Castable
+{
+    /**
+     * Get the caster class to use when casting from / to this cast target.
+     *
+     * @param  array  $arguments
+     * @return object|string
+     */
+    public static function castUsing(array $arguments)
+    {
+        return new class implements CastsAttributes {
+            public function get($model, $key, $value, $attributes)
+            {
+                return new Collection(json_decode(Crypt::decryptString($attributes[$key]), true));
+            }
+
+            public function set($model, $key, $value, $attributes)
+            {
+                return [$key => Crypt::encryptString(json_encode($value))];
+            }
+        };
+    }
+}

tests/Integration/Database/DatabaseArrayObjectAndCollectionCustomCastTest.php

@@ -0,0 +1,75 @@
+<?php
+
+namespace Illuminate\Tests\Integration\Database;
+
+use Illuminate\Database\Eloquent\Casts\AsArrayObject;
+use Illuminate\Database\Eloquent\Casts\AsCollection;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+/**
+ * @group integration
+ */
+class DatabaseArrayObjectAndCollectionCustomCastTest extends DatabaseTestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        Schema::create('test_eloquent_model_with_custom_array_object_casts', function (Blueprint $table) {
+            $table->increments('id');
+            $table->text('array_object');
+            $table->text('collection');
+            $table->timestamps();
+        });
+    }
+
+    public function test_array_object_and_collection_casting()
+    {
+        $model = new TestEloquentModelWithCustomArrayObjectCast;
+
+        $model->array_object = ['name' => 'Taylor'];
+        $model->collection = collect(['name' => 'Taylor']);
+
+        $model->save();
+
+        $model = $model->fresh();
+
+        $this->assertEquals(['name' => 'Taylor'], $model->array_object->toArray());
+        $this->assertEquals(['name' => 'Taylor'], $model->collection->toArray());
+
+        $model->array_object['age'] = 34;
+        $model->array_object['meta']['title'] = 'Developer';
+
+        $model->save();
+
+        $model = $model->fresh();
+
+        $this->assertEquals([
+            'name' => 'Taylor',
+            'age' => 34,
+            'meta' => ['title' => 'Developer'],
+        ], $model->array_object->toArray());
+    }
+}
+
+class TestEloquentModelWithCustomArrayObjectCast extends Model
+{
+    /**
+     * The attributes that aren't mass assignable.
+     *
+     * @var string[]
+     */
+    protected $guarded = [];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'array_object' => AsArrayObject::class,
+        'collection' => AsCollection::class,
+    ];
+}