Add support for php 8.1 enums for choice field #4988

cobyl · 2022-01-20T18:06:23Z

Proposed change allows to use php 8.1 enum in choice field:

if we have enum in entity:

    #[ORM\Column(type: Types::STRING, length: 8, nullable: true, enumType: Status::class)]
    private Status $status;

then we can in configureFields:

        $status = ChoiceField::new('status')->setChoices(Status::cases());
//or
        $status = ChoiceField::new('status')->setChoices(
            array_reduce(Status::cases(), function (array $elements, Status $status) {
                return $elements + ['enum.status.'.$status->value => $status];
            }, [])
        );
//or
        $status = ChoiceField::new('status');

without that change in the case of enums we got the error "Warning: array_flip(): Can only flip string and integer values, entry skipped" there:

        $flippedChoices = array_flip($choices);

cobyl · 2022-01-20T18:23:44Z

issue: #4989

cobyl · 2022-01-20T18:59:54Z

Because of doctrine limitations work only with this kind of enums:

enum Status:string
{
    case WAITING = 'waiting';
    case ERROR = 'error';
}

and NOT with

enum Status
{
    case WAITING;
    case ERROR;
}

oleg-andreyev · 2022-01-28T09:19:13Z

Since Symfony has EnumType we can do it like this (workaround):

// for index because of array_flip
            ChoiceField::new('packingType')
                ->onlyOnIndex()
                ->setChoices(function () {
                    $choices = array_map(static fn (?PackingUnit $unit) => [$unit->value => $unit->name], PackingUnit::cases());

                    return array_merge(...$choices);
                })
                ->setFormType(EnumType::class)
                ->setFormTypeOption('class', PackingUnit::class)
                ->setFormTypeOption('choice_label', function (PackingUnit $enum) {
                    return $enum->value;
                }),
// for form
            ChoiceField::new('packingType')
                ->onlyOnForms()
                ->setChoices(function () {
                    $choices = array_map(static fn (?PackingUnit $unit) => [$unit->value => $unit], PackingUnit::cases());

                    return array_merge(...$choices);
                })
                ->setFormType(EnumType::class)
                ->setFormTypeOption('class', PackingUnit::class)
                ->setFormTypeOption('choice_label', function (PackingUnit $enum) {
                    return $enum->value;
                }),

ERuban · 2022-02-03T15:38:22Z

@oleg-andreyev didn't work for me...
waiting for this PR

oleg-andreyev · 2022-02-03T17:19:03Z

@ERuban updated my workaround.

akalineskou · 2022-02-05T01:03:18Z

src/Field/Configurator/ChoiceConfigurator.php

+                    });
+                } else {
+                    $choices = array_reduce($choices, function ($elements, $enum) {
+                        return $elements + [$enum->value => $enum->value];


Symfony uses enums as name => value in forms

https://symfony.com/blog/new-in-symfony-5-4-php-enumerations-support#php-enums-support-in-symfony-forms

akalineskou · 2022-02-05T01:23:36Z

For me this fixes it for all pages (with the current implementation)

$choiceField = ChoiceField::new('status')
    ->setChoices(Status::cases())
    ->setFormType(EnumType::class)
    ->setFormTypeOption('class', Status::class)
;

if (in_array($pageName, [Crud::PAGE_INDEX, Crud::PAGE_DETAIL], true)) {
    $choiceField->setChoices(array_reduce(
        Status::cases(),
        static fn (array $choices, Status $status) => $choices + [$status->name => $status->value],
        [],
    ));
}

yield $choiceField;

shaneparsons · 2022-04-08T19:39:08Z

A couple of the workarounds here work, but cause duplication if the key matches the value. e.g.

case OTHER = 'OTHER';

Results in:

OTHER, OTHER

asanikovich · 2022-05-31T11:19:58Z

@javiereguiluz please, take a look on this

Snowbaha · 2022-06-24T08:44:02Z

For me this fixes it for all pages (with the current implementation)

$choiceField = ChoiceField::new('status')
    ->setChoices(Status::cases())
    ->setFormType(EnumType::class)
    ->setFormTypeOption('class', Status::class)
;

if (in_array($pageName, [Crud::PAGE_INDEX, Crud::PAGE_DETAIL], true)) {
    $choiceField->setChoices(array_reduce(
        Status::cases(),
        static fn (array $choices, Status $status) => $choices + [$status->name => $status->value],
        [],
    ));
}

yield $choiceField;

it looks nice for me, but it is not possible to use the ->setTranslatableChoices() in this case.
Or maybe use a different label displayed instead of the Enum name.

Here is an example:

My Enum:

enum PageContentType: string
{
    case Banner = 'banner';
    case Iframe = 'iframe';
    case Image = 'image';
    case Quote = 'quote';

    public function label(): string
    {
        return match($this)
        {
            self::Banner => 'Bannière',
            self::Iframe => 'Iframe (vidéo / map)',
            self::Image => 'Image et texte',
            self::Quote => 'Citation',
        };
    }
}

And there the Field:

 ChoiceField::new('type', 'Type')->setColumns(4)
                ->setChoices(PageContentType::cases())
                ->setFormType(EnumType::class)
                ->setFormTypeOption('class', PageContentType::class)

In the first case, The label displayed on the EA select is "Banner" with the value "banner" but I would like to display a specific label (I tried with the function label()) or be able to translate the "Banner" ?

Maybe it is an issue related to EnumType itself...

EDIT:

If I create a "messages.fr.yaml" with Banner: "Bannière FR"

We can see the translation.
Is it a good way of translation the Enum Key in translation file without write a speciale var like "label.banner"?

oussj · 2022-12-27T13:24:28Z

Hello What's the status of this PR ? :) it would be very useful, I had to abandon enum for the moment and go for a class with const instead

kiler129 · 2023-01-21T07:11:41Z

One another area, which this PR doesn't address, is the ChoiceFilter. Maybe it would be good to include this as well?

javiereguiluz · 2023-02-04T12:29:14Z

Thanks Tomek! This has been finally merged!

I added some tests/docs (934d5e6) but it'd be great if more people could test this in real apps before tagging a new release. Thanks!

ksn135 · 2023-02-06T08:24:42Z

Thanks, it works, add PR #5610 with some php-cs-fixer and PHP < 8.1 issues

abozhinov · 2023-02-08T11:16:59Z

Hi,
I have errors when use Enum with ChoiceField.

Entity implementation:

Controller:
yield ChoiceField::new('weight.unit', new TranslatableMessage('weight.unit.label'))
->setColumns('form-field--small');

Before this last release I've used it like that:
yield ChoiceField::new('weight.unit', new TranslatableMessage('weight.unit.label'))
->setChoices($isInfoPage ? WeightUnit::getAsArray() : WeightUnit::cases())
->setFormType(EnumType::class)
->setFormTypeOption('class', WeightUnit::class)
->setFormTypeOption('choice_label', function (WeightUnit $enum) {
return new TranslatableMessage('weight.unit.'.$enum->value);
})
->setCustomOption(ChoiceField::OPTION_USE_TRANSLATABLE_CHOICES, $isInfoPage)
->setColumns('form-field--small');

The problem is that wen I use ChoiceType symfony can't convert Enum value because I don't use EnumType.

babwar · 2023-02-08T17:30:11Z

@abozhinov

Same problem. It can be solve in your entity by changing the getter method
ex

#[ORM\Column(type: 'string', length: 10, enumType: UserType::class, name: "user_type")]
private ?UserType $type = null;

public function getTypeEnum(): ?UserType 
{
      return $this->type;
}

public function getType(): ?string
{
      return $this->type?->value;
}

public function setType($type): self
{
     if(!$type instanceof UserType ) {
          $type= UserType::from($type);
     }
     $this->type = $type;
     return $this;
}

abozhinov · 2023-02-08T18:08:55Z

There is no point to use Enum and return string. I think the best will be to adapt ChoiceField to use EnumType.

babwar · 2023-02-08T18:33:48Z

I don't say it's the solution. I just put here my quickest solution i used (it can help someone).
It's not a minor release (my app was broken today when putting it in prod).

javiereguiluz · 2023-02-08T19:20:25Z

@abozhinov thanks for reporting this. I'd need your help to solve it. I've created #5620 but I'm not sure if it's the right fix. Thanks.

abozhinov · 2023-02-08T19:26:13Z

@javiereguiluz the issue is that ChoiceType can't convert Enum to String. I think we should create new EnumField to move the logic from ChoiceField to the new field type.

COil · 2023-02-09T16:51:05Z

I have the same problem. +1 for a new dedicated EnumField.

ksn135 · 2023-02-15T13:45:13Z

Well, I decided this as a workaround for the current 4.x branch.
Javier @javiereguiluz how to implement this better in the bundle itself?

<?xml version="1.0" encoding="UTF-8"?>
<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
                  xmlns:gedmo="http://gediminasm.org/schemas/orm/doctrine-extensions-mapping">
    <entity name="Ksn135\CompanyBundle\Entity\DocSetting">

...
        <field name="type" type="string" length="20" nullable="false" enum-type="Ksn135\CompanyBundle\Enums\DocType" />
...    

    </entity>
</doctrine-mapping>

enum DocType: string
{
    case INDIVIDUAL = 'individual';
    case TYPICAL = 'typical';

    public static function choices(): array
    {
        return [
            'admin_label.enum.docType.' . self::INDIVIDUAL->value => self::INDIVIDUAL->name,
            'admin_label.enum.docType.' . self::TYPICAL->value => self::TYPICAL->name,
        ];
    }
}

class DocSettingCrudController extends AbstractCrudController
{
...
    public function createEditFormBuilder(EntityDto $entityDto, KeyValueStore $formOptions, AdminContext $context): FormBuilderInterface
    {
        $builder = parent::createEditFormBuilder($entityDto, $formOptions, $context);
        $builder->get('type')->addModelTransformer(
            new CallbackTransformer(
                static fn(mixed $value): mixed => $value, // no convertion
                static fn(?string $value): ?DocType => DocType::tryFrom($value)
            )
        );

        return $builder;
    }

    public function configureFields(string $pageName): iterable
    {
        return [
...
            Fields\ChoiceField::new ('type', 'admin_label.doc.field.type')->setRequired(true)
                ->setFormType(EnumType::class)
                ->setFormTypeOption('class', DocType::class)
                ->setFormTypeOption('choice_label', static fn($choice): ?string => 'admin_label.enum.docType.' . strtolower($choice))
                ->setFormTypeOption('choice_value', static fn($choice): ?string => $choice instanceof \BackedEnum ? $choice->value : $choice)
                ->setChoices(\in_array($pageName, [Crud::PAGE_INDEX, Crud::PAGE_DETAIL], true) ? DocType::choices() : DocType::cases())
...
     ];
  }
}

# messages.en.yaml
admin_label:
  enum:
    docType:
      individual: The Individual
      typical: Very typical

abozhinov · 2023-02-18T13:47:31Z

I found a solution. Check my PR -> #5640

cobyl mentioned this pull request Jan 20, 2022

PHP 8.1 enums & choice field #4989

Closed

javiereguiluz added the feature label Jan 20, 2022

javiereguiluz added this to the 4.x milestone Jan 20, 2022

akalineskou reviewed Feb 5, 2022

View reviewed changes

javiereguiluz added the priority: important Bugs to fix and features to implement label Dec 7, 2022

Add support for php 8.1 enums for choice field

f492365

javiereguiluz force-pushed the patch-1 branch from 92cdf19 to f492365 Compare February 4, 2023 10:00

javiereguiluz merged commit 2eaf3f1 into EasyCorp:4.x Feb 4, 2023

javiereguiluz mentioned this pull request Feb 8, 2023

Fix some issues in Choice field with PHP Enums #5620

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for php 8.1 enums for choice field #4988

Add support for php 8.1 enums for choice field #4988

cobyl commented Jan 20, 2022 •

edited

Loading

cobyl commented Jan 20, 2022

cobyl commented Jan 20, 2022 •

edited

Loading

oleg-andreyev commented Jan 28, 2022 •

edited

Loading

ERuban commented Feb 3, 2022

oleg-andreyev commented Feb 3, 2022

akalineskou Feb 5, 2022 •

edited

Loading

akalineskou commented Feb 5, 2022 •

edited

Loading

shaneparsons commented Apr 8, 2022

asanikovich commented May 31, 2022

Snowbaha commented Jun 24, 2022 •

edited

Loading

oussj commented Dec 27, 2022

kiler129 commented Jan 21, 2023

javiereguiluz commented Feb 4, 2023

ksn135 commented Feb 6, 2023

abozhinov commented Feb 8, 2023

babwar commented Feb 8, 2023 •

edited

Loading

abozhinov commented Feb 8, 2023 •

edited

Loading

babwar commented Feb 8, 2023 •

edited

Loading

javiereguiluz commented Feb 8, 2023

abozhinov commented Feb 8, 2023

COil commented Feb 9, 2023 •

edited

Loading

ksn135 commented Feb 15, 2023

abozhinov commented Feb 18, 2023

Add support for php 8.1 enums for choice field #4988

Add support for php 8.1 enums for choice field #4988

Conversation

cobyl commented Jan 20, 2022 • edited Loading

cobyl commented Jan 20, 2022

cobyl commented Jan 20, 2022 • edited Loading

oleg-andreyev commented Jan 28, 2022 • edited Loading

ERuban commented Feb 3, 2022

oleg-andreyev commented Feb 3, 2022

akalineskou Feb 5, 2022 • edited Loading

Choose a reason for hiding this comment

akalineskou commented Feb 5, 2022 • edited Loading

shaneparsons commented Apr 8, 2022

asanikovich commented May 31, 2022

Snowbaha commented Jun 24, 2022 • edited Loading

oussj commented Dec 27, 2022

kiler129 commented Jan 21, 2023

javiereguiluz commented Feb 4, 2023

ksn135 commented Feb 6, 2023

abozhinov commented Feb 8, 2023

babwar commented Feb 8, 2023 • edited Loading

abozhinov commented Feb 8, 2023 • edited Loading

babwar commented Feb 8, 2023 • edited Loading

javiereguiluz commented Feb 8, 2023

abozhinov commented Feb 8, 2023

COil commented Feb 9, 2023 • edited Loading

ksn135 commented Feb 15, 2023

abozhinov commented Feb 18, 2023

cobyl commented Jan 20, 2022 •

edited

Loading

cobyl commented Jan 20, 2022 •

edited

Loading

oleg-andreyev commented Jan 28, 2022 •

edited

Loading

akalineskou Feb 5, 2022 •

edited

Loading

akalineskou commented Feb 5, 2022 •

edited

Loading

Snowbaha commented Jun 24, 2022 •

edited

Loading

babwar commented Feb 8, 2023 •

edited

Loading

abozhinov commented Feb 8, 2023 •

edited

Loading

babwar commented Feb 8, 2023 •

edited

Loading

COil commented Feb 9, 2023 •

edited

Loading