Support AsEnumCollection cast

[susanu]

I have one attribute that stores multiple enum values.
Currently there is no field/column that support this.
Do you think is good addition to the current list of fields & columns?

[backpack-ai-bot[bot]]

Based on the knowledge sources provided, there isn't specific information about supporting AsEnumCollection cast or storing multiple enum values in a single attribute for Backpack. However, I can provide some relevant information about enum support in Backpack:

Backpack has recently added support for PHP Enums (introduced in PHP 8.1) in fields and columns. According to the PHP Enums support pull request, Backpack now supports using fields casted to an Enum::class.

For fields, Backpack provides an enum field type that can work with both database ENUMs and PHP enums. As described in the Backpack documentation for enum fields, you can use it like this:

CRUD::field([
    'name'  => 'status',
    'label' => 'Status',
    'type'  => 'enum'
]);

However, the current implementation doesn't seem to directly support storing multiple enum values in a single attribute or using AsEnumCollection cast.

While it's not exactly what you're asking for, you might be able to achieve something similar using the repeatable field type or by customizing the enum field type. However, without more specific information in the knowledge sources, I can't provide a definitive answer on whether supporting AsEnumCollection cast would be a good addition to the current list of fields & columns.

If you believe this feature would be beneficial, you might consider opening a feature request on the Backpack GitHub repository to discuss its potential implementation with the maintainers.

ℹ️ Please note our AI Bot does not reply to follow-ups, this will be the only AI answer in this thread. If the AI helped you find the answer, please mark it as answered or write details below so it can learn. Then close the conversation. If not, please give more information for when a human reads this. ℹ️

Relevant sources:

Github Issue (closed): Attribute Casting causes error
Github Issue (closed): [Bug] mb_strwidth(): Argument 1 ($string) must be of type string, App\Enums\Status given
Github Issue (closed): crud.field() js library bugs
PHP Enums support
Github Issue (closed): [COLUMNS] Extendable column types.
suggest select_from_array when enum field is not supported
Columns|multidimensional_array
Github Issue (closed): [4.0 & 4.1][Bug?] Adding a column without TYPE does not work for Enum
Fields|enum
[EH] add possibility to use custom fields
Github Issue (closed): [BUG] Fluent Syntax: enum field
Github Issue (closed): Feature wanted: ability to store multiple fields into one database attribute
Github Issue (closed): [Feature Request] Repeatable column type

[pxpm]

@susanu thanks. 🙏

What do you mean multiple enum values? A JSON in the database? {type: value1, brand: value2, color: value3 } ? It looks like the repeatable could handle that with max_rows => 1 and min_rows => 1 ?

If not can you show me a bit more of what you mean ?

Cheers

[susanu]

The data is saved into the database as a json array, when the model is loaded, is transformed into a Collection with enums (the class)

SmsScope.php

<?php

enum SmsScope: string
{
    case AbandonedCart = 'abandoned_cart';
    case Campaign = 'campaign';
}

Model (casts function)

['scopes' => Illuminate\Database\Eloquent\Casts\AsEnumCollection::of(SmsScope::class)];

Database

["campaign","abandoned_cart"]

OR

["campaign"]

Column

CRUD::column('scopes')
    ->type('text')
    ->value(fn($entry) => $entry->scopes->implode(fn(SmsScope $s) => $s->name, ', '));

Currently i use the field type select2_from_array but i transform the attribute from Collection to normal array when the model is retrieved.

[pxpm]

Thanks for clarifying @susanu 🙏

Ok, I think it's a reasonable request to implement since we already support single enum values. Any chance this could be dealt with enum column/field we currently have in a conditional?

My idea is that enum could support both the Enum cast and the AsEnumCollection so you don't need to remember and/or define different column types/field types for each of the enums. It's an enum? Use the enum column/field.

What do you think ?

Cheers

[susanu]

Yes, you are totally right.
You can target collection of enums by checking the cast if is AsEnumCollection.

Thank you!

[pxpm]

Hey @susanu

We've added support for AsEnumCollection cast.

Let me know if that works for you 👍

[mattsches]

I've just upgraded to 6.7.48 (from 6.7.43), and I run in to an error with enums. I haven't looked at it any closer now, but it happens when calling the columns/enum.blade.php view, and the error message is Call to a member function transform() on string;

I'll let you know once I find out more.

[pxpm]

Will investigate too, thanks 👍

[pxpm]

@mattsches released a new crud version with the fix. Let me know if you are still experiencing problems. 👍

[mattsches]

@pxpm Thanks for the quick reply and fix.
I actually fixed my issue by defining the enum_class in the column/field configs - which I hadn't previously (but it still had worked). I also found that my actual Enum class lacked cases and only had constants, so I changed that, too. These two changes seem to have fixed the issue for me with 6.7.48 - but I'll update to 6.7.49 and check if it works there, too.

[mattsches]

Ok, still looking good after update to 6.7..49.

I also tried and reverted my changes and tested the old version of my code against 6.7.49 - works, too! So, good job 👍