Add $casts class AsEnumArray

[whobutsb]

I started thinking of an idea of being able to save an array of Enums objects as to a json array and then when they are returned they would then be cast as the correct Enum objects.

I created my own casting class to handle this. Is there any interest in adding this to the Laravel framework? If you're all interested I could write a pull request and add it to Illuminate\Database\Eloquent\Casts and call it: AsEnumArray?

Code improvements and suggestions are always appreciated :).

protected $casts = [
    'options' => \App\Casts\EnumArray::class.':'.\App\Enums\MyEnums::class
 ];

<?php
 
namespace App\Casts;

use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
use Illuminate\Support\Collection;

class EnumArray implements CastsAttributes
{
    /**
     * The enum class.
     *
     * @var string
     */
    protected string $enumClass;
 
    /**
     * Create a new cast class instance.
     *
     * @param  string  $enumClass
     * @return void
     */
    public function __construct(string $enumClass)
    {
        $this->enumClass = $enumClass;
    }

    /**
     * Cast the given value.
     *
     * @param  \Illuminate\Database\Eloquent\Model  $model
     * @param  string  $key
     * @param  mixed  $value
     * @param  array  $attributes
     * @return array
     */
    public function get($model, $key, $value, $attributes): array
    {
        $values = json_decode($value);

        return collect($values)->map(function($value){
            return $this->match($value);
        })->toArray();
    }

    /**
     * Match the string value with enum case
     *
     * @param string $value
     * @return mixed
     */
    protected function match(string $value): mixed
    {
        return collect($this->enumClass::cases())->filter(function($enum) use($value){  
            return $value == $enum->value;
        })->first();
    }
 
    /**
     * Prepare the given value for storage.
     *
     * @param  \Illuminate\Database\Eloquent\Model  $model
     * @param  string  $key
     * @param  array  $value
     * @param  array  $attributes
     * @return Collection
     */
    public function set($model, $key, $value, $attributes): Collection
    {
        return collect($value)->map(function($enum){
            if(is_string($enum)){
                return $this->match($enum)->value;
            }

            return $enum->value;
        });

    }
}

[artworkad]

#45621