Merge pull request #5747 from Laravel-Backpack/add-enum-collection-cast-support

add enum collection cast support

Author: pxpm

src/resources/views/crud/columns/enum.blade.php

@@ -11,9 +11,69 @@
                 }
                 
                 $column['value'] = isset($column['enum_function']) ? $enumClass->{$column['enum_function']}() : $column['value'];
+            }else{
+                $column['value'] = $column['value']->transform(function($item) use ($column) {
+                    return $item instanceof \BackedEnum ? $item->value : $item->name;
+                })->toArray();
             }
         }
     }
+
+    if(!isset($column['options']) && is_array($column['value'])) {
+        $column['options'] = (function() use ($entry, $column) {
+
+            // if we are in a PHP version where PHP enums are not available, it can only be a database enum
+            if(! function_exists('enum_exists')) {
+                $options = $entity_model::getPossibleEnumValues($column['name']);
+                return array_combine($options, $options);
+            }
+                    // developer can provide the enum class so that we extract the available options from it
+            $enumClassReflection = isset($column['enum_class']) ? new \ReflectionEnum($column['enum_class']) : false;
+
+            if(! $enumClassReflection) {
+                // check for model casting
+                $possibleEnumCast = $entry->getCasts()[$column['name']] ?? false;
+
+                if($possibleEnumCast) {
+                    if(class_exists($possibleEnumCast)) {
+                        $enumClassReflection = new \ReflectionEnum($possibleEnumCast);
+                    }else{
+                        // It's an `AsEnumCollection` cast
+                        if(str_contains($possibleEnumCast, ':')) {
+                            $enumClassReflection = new \ReflectionEnum(explode(':', $possibleEnumCast)[1]);
+                            $allowMultipleValues = true;
+                        }   
+                    }
+                }
+            }
+
+            if($enumClassReflection) {
+                $options = array_map(function($item) use ($enumClassReflection) {
+                    return $enumClassReflection->isBacked() ? [$item->getBackingValue() => $item->name] : $item->name;
+                },$enumClassReflection->getCases());
+                $options = is_multidimensional_array($options) ? array_replace(...$options) : array_combine($options, $options);
+            }
+
+            if(isset($column['enum_function']) && isset($options)) {
+                $options = array_map(function($item) use ($column, $enumClassReflection) {
+                    if ($enumClassReflection->hasConstant($item)) {
+                        return $enumClassReflection->getConstant($item)->{$column['enum_function']}();
+                    }
+                    return $item;
+                }, $options);
+                return $options;
+            }
+
+            // if we have the enum options return them
+            if(isset($options)) {
+                return $options;
+            }
+
+            // no enum options, can only be database enum
+            $options = $entity_model::getPossibleEnumValues($column['name']);
+            return array_combine($options, $options);
+        })();
+    }
 @endphp
 
 @include(isset($column['options']) ? 'crud::columns.select_from_array' : 'crud::columns.text')

src/resources/views/crud/fields/enum.blade.php

@@ -4,6 +4,8 @@
 
     $field['value'] = old_empty_or_null($field['name'], '') ??  $field['value'] ?? $field['default'] ?? '';
 
+    $allowMultipleValues = $field['multiple'] ?? false;
+
     $possible_values = (function() use ($entity_model, $field) {
         $fieldName = $field['baseFieldName'] ?? $field['name'];
         // if developer provided the options, use them, no need to guess.
@@ -16,15 +18,24 @@
             $options = $entity_model::getPossibleEnumValues($fieldName);
             return array_combine($options, $options);
         }
-
+        
         // developer can provide the enum class so that we extract the available options from it
         $enumClassReflection = isset($field['enum_class']) ? new \ReflectionEnum($field['enum_class']) : false;
 
         if(! $enumClassReflection) {
             // check for model casting
             $possibleEnumCast = (new $entity_model)->getCasts()[$fieldName] ?? false;
-            if($possibleEnumCast && class_exists($possibleEnumCast)) {
-                $enumClassReflection = new \ReflectionEnum($possibleEnumCast);
+
+            if($possibleEnumCast) {
+                if(class_exists($possibleEnumCast)) {
+                    $enumClassReflection = new \ReflectionEnum($possibleEnumCast);
+                }else{
+                    // It's an `AsEnumCollection` cast
+                    if(str_contains($possibleEnumCast, ':')) {
+                        $enumClassReflection = new \ReflectionEnum(explode(':', $possibleEnumCast)[1]);
+                        $allowMultipleValues = true;
+                    }   
+                }
             }
         }
 
@@ -55,18 +66,27 @@
         return array_combine($options, $options);
     })();
 
-
-    if(function_exists('enum_exists') && !empty($field['value']) && $field['value'] instanceof \UnitEnum)  {
-        $field['value'] = $field['value'] instanceof \BackedEnum ? $field['value']->value : $field['value']->name;
+    if(function_exists('enum_exists') && !empty($field['value']))  {
+        match(true) {
+            $field['value'] instanceof \UnitEnum => $field['value'] = $field['value'] instanceof \BackedEnum ? $field['value']->value : $field['value']->name,
+            $field['value'] instanceof Illuminate\Support\Collection => $field['value'] = $field['value']->map(function($item) {
+                return $item instanceof \UnitEnum ? $item instanceof \BackedEnum ? $item->value : $item->name : $item;
+            })->toArray(),
+            default => null
+        };
+        $field['value'] = is_array($field['value']) ? $field['value'] : [$field['value']];
     }
 @endphp
 
 @include('crud::fields.inc.wrapper_start')
     <label>{!! $field['label'] !!}</label>
     @include('crud::fields.inc.translatable_icon')
     <select
-        name="{{ $field['name'] }}"
+        name="{{ $allowMultipleValues ? $field['name'].'[]' : $field['name'] }}"
         @include('crud::fields.inc.attributes', ['default_class' => 'form-control form-select'])
+        @if ($allowMultipleValues)
+            multiple
+        @endif
         >
 
         @if ($entity_model::isColumnNullable($field['name']))
@@ -76,7 +96,7 @@
             @if (count($possible_values))
                 @foreach ($possible_values as $key => $possible_value)
                     <option value="{{ $key }}"
-                        @if ($field['value']==$key)
+                        @if (in_array($key, $field['value']))
                             selected
                         @endif
                     >{{ $possible_value }}</option>