Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for Enums in Choice fields #5740

Closed
wants to merge 3 commits into from
+34 −8
Closed

Add support for Enums in Choice fields #5740

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
76b9d53
Update ChoiceConfigurator.php
abozhinov Feb 17, 2023
2f05e59
-
javiereguiluz May 1, 2023
4c44bde
-
javiereguiluz May 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
"symfony/http-foundation": "^5.4|^6.0",
"symfony/http-kernel": "^5.4|^6.0",
"symfony/intl": "^5.4|^6.0",
"symfony/polyfill-php81": "^1.27",
"symfony/property-access": "^5.4|^6.0",
"symfony/security-bundle": "^5.4|^6.0",
"symfony/string": "^5.4|^6.0",
Expand Down
7 changes: 7 additions & 0 deletions src/Factory/FieldFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,13 @@ public function processFields(EntityDto $entityDto, FieldCollection $fields): vo
$configurator->configure($fieldDto, $entityDto, $context);
}

// check again if the field is displayed because this can change in the configurators
if (null !== $currentPage && false === $fieldDto->isDisplayedOn($currentPage)) {
$fields->unset($fieldDto);

continue;
}

foreach ($fieldDto->getFormThemes() as $formThemePath) {
$context?->getCrud()?->addFormTheme($formThemePath);
}
Expand Down
34 changes: 26 additions & 8 deletions src/Field/Configurator/ChoiceConfigurator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
use EasyCorp\Bundle\EasyAdminBundle\Field\ChoiceField;
use EasyCorp\Bundle\EasyAdminBundle\Translation\TranslatableChoiceMessage;
use EasyCorp\Bundle\EasyAdminBundle\Translation\TranslatableChoiceMessageCollection;
use Symfony\Component\Form\Extension\Core\Type\EnumType;
use function Symfony\Component\String\u;
use function Symfony\Component\Translation\t;
use Symfony\Contracts\Translation\TranslatableInterface;
Expand Down Expand Up @@ -38,7 +39,8 @@ public function configure(FieldDto $field, EntityDto $entityDto, AdminContext $c
// in that case, get all the possible values of the Enum
if (null === $choices && $enumsAreSupported) {
$enumTypeClass = $field->getDoctrineMetadata()->get('enumType');
if (enum_exists($enumTypeClass)) {
if (is_string($enumTypeClass) && enum_exists($enumTypeClass)) {
$field->setFormTypeOption('class', $enumTypeClass);
$choices = $enumTypeClass::cases();
}
}
Expand All @@ -48,20 +50,19 @@ public function configure(FieldDto $field, EntityDto $entityDto, AdminContext $c
}

// support for enums
$allChoicesAreEnums = false;
if ($enumsAreSupported) {
$elementIsEnum = array_unique(array_map(static function ($element): bool {
return \is_object($element) && enum_exists($element::class);
}, $choices));
$allChoicesAreEnums = false === \in_array(false, $elementIsEnum, true);

if ($allChoicesAreEnums) {
$field->setFormType(EnumType::class);

$processedEnumChoices = [];
foreach ($choices as $choice) {
if ($choice instanceof \BackedEnum) {
$processedEnumChoices[$choice->name] = $choice->value;
} else {
$processedEnumChoices[$choice->name] = $choice->name;
}
$processedEnumChoices[$choice->name] = $choice;
}

$choices = $processedEnumChoices;
Expand All @@ -70,7 +71,15 @@ public function configure(FieldDto $field, EntityDto $entityDto, AdminContext $c

if ($areChoicesTranslatable) {
$field->setFormTypeOptionIfNotSet('choices', array_keys($choices));
$field->setFormTypeOptionIfNotSet('choice_label', fn ($value) => $choices[$value]);
$field->setFormTypeOptionIfNotSet('choice_label', static function ($value) use ($choices) {
$key = match (true) {
\is_object($value) && enum_exists($value::class) => $value->name,
\is_object($value) => (string) $value,
default => $value,
};

return $choices[$key];
});
} else {
$field->setFormTypeOptionIfNotSet('choices', $choices);
}
Expand Down Expand Up @@ -108,12 +117,21 @@ public function configure(FieldDto $field, EntityDto $entityDto, AdminContext $c
$translationDomain = $context->getI18n()->getTranslationDomain();
$choiceMessages = [];
// Translatable choice don't need to get flipped
$flippedChoices = $areChoicesTranslatable ? $choices : array_flip($this->flatten($choices));
$flippedChoices = ($areChoicesTranslatable || $allChoicesAreEnums) ? $choices : array_flip($this->flatten($choices));
foreach ((array) $fieldValue as $selectedValue) {
if (null !== $selectedLabel = $flippedChoices[$selectedValue] ?? null) {
if ($selectedValue instanceof TranslatableInterface) {
$choiceMessage = $selectedValue;
} else {
if (\is_object($selectedLabel) && enum_exists($selectedLabel::class)) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should also add && !$field->getFormTypeOption('choice_label')

$selectedLabel = $selectedLabel->name;
} elseif (\is_object($selectedLabel)) {
$labelCallback = $field->getFormTypeOption('choice_label');
if (\is_callable($labelCallback)) {
$selectedLabel = $labelCallback($selectedLabel);
}
}

$choiceMessage = t(
$selectedLabel,
$translationParameters,
Expand Down