Merge branch '4.x' into 5.x

* 4.x:
  Tweaks
  Add choice_label support to CrudAutocompleteType

Author: javiereguiluz

src/Form/EventListener/CrudAutocompleteSubscriber.php

@@ -2,7 +2,6 @@
 
 namespace EasyCorp\Bundle\EasyAdminBundle\Form\EventListener;
 
-use Doctrine\ORM\Mapping\FieldMapping;
 use Symfony\Bridge\Doctrine\Form\Type\EntityType;
 use Symfony\Bridge\Doctrine\Types\UlidType;
 use Symfony\Bridge\Doctrine\Types\UuidType;
@@ -40,29 +39,31 @@ public function preSetData(FormEvent $event): void
         $options['compound'] = false;
         $options['choices'] = is_iterable($data) ? $data : [$data];
 
-        // apply custom choice_label if autocomplete is customized so the selected item looks the same as the other entries.
-        // note: we don't escape here because Twig already escapes the <option> content automatically;
-        // the renderAsHtml flag controls how TomSelect renders the item (via data-ea-autocomplete-render-items-as-html).
+        // strip EA-specific options before forwarding to EntityType
         $callback = $options['autocomplete_callback'] ?? null;
         $template = $options['autocomplete_template'] ?? null;
-
-        if (null !== $template) {
-            $twig = $this->twig;
-            $options['choice_label'] = static function ($entity) use ($twig, $template): string {
-                return $twig->render($template, ['entity' => $entity]);
-            };
-        } elseif (null !== $callback) {
-            $options['choice_label'] = static function ($entity) use ($callback): string {
-                return (string) $callback($entity);
-            };
+        unset($options['autocomplete_callback'], $options['autocomplete_template']);
+
+        // Resolve choice_label:
+        // - if the user supplied one (via value_type_options.choice_label), keep it;
+        // - otherwise derive one from autocomplete_template / autocomplete_callback so the
+        //   selected item matches the rendering of other entries in the dropdown;
+        // - otherwise drop the option entirely so EntityType falls back to __toString().
+        //
+        // Note: we don't escape here because Twig already escapes the <option> content
+        // automatically; the renderAsHtml flag controls how TomSelect renders the item
+        // (via data-ea-autocomplete-render-items-as-html).
+        if (null === ($options['choice_label'] ?? null)) {
+            if (null !== $template) {
+                $twig = $this->twig;
+                $options['choice_label'] = static fn ($entity): string => $twig->render($template, ['entity' => $entity]);
+            } elseif (null !== $callback) {
+                $options['choice_label'] = static fn ($entity): string => (string) $callback($entity);
+            } else {
+                unset($options['choice_label']);
+            }
         }
 
-        // remove custom options before passing to EntityType
-        unset(
-            $options['autocomplete_callback'],
-            $options['autocomplete_template']
-        );
-
         $form->add('autocomplete', EntityType::class, $options);
     }
 

src/Form/Type/CrudAutocompleteType.php

@@ -9,6 +9,7 @@
 use Symfony\Component\Form\FormInterface;
 use Symfony\Component\Form\FormView;
 use Symfony\Component\OptionsResolver\OptionsResolver;
+use Symfony\Component\PropertyAccess\PropertyPath;
 use Twig\Environment;
 
 /**
@@ -48,11 +49,17 @@ public function configureOptions(OptionsResolver $resolver): void
             // options for custom rendering of selected items (to match the rendering of the other entries in the dropdown)
             'autocomplete_callback' => null,
             'autocomplete_template' => null,
+            // forwarded to the underlying EntityType so users can customize the
+            // label of the selected items via setFormTypeOption('value_type_options', ...)
+            'choice_label' => null,
         ]);
 
         $resolver->setRequired(['class']);
         $resolver->setAllowedTypes('autocomplete_callback', ['null', 'callable']);
         $resolver->setAllowedTypes('autocomplete_template', ['null', 'string']);
+        // mirror Symfony's ChoiceType allowed types for choice_label so anything accepted by
+        // EntityType is also accepted here (we only skip ChoiceLabel::class, which is marked as internal)
+        $resolver->setAllowedTypes('choice_label', ['null', 'bool', 'callable', 'string', PropertyPath::class]);
     }
 
     public function getBlockPrefix(): string

tests/Unit/Filter/CrudAutocompleteTypeTest.php

@@ -151,4 +151,80 @@ public function testSubmitEmptyMultipleData(): void
         $this->assertTrue($form->isSynchronized());
         $this->assertEquals(new ArrayCollection(), $form->getData());
     }
+
+    public function testCustomChoiceLabelIsPreserved(): void
+    {
+        $project = (new Project())->setId(123)->setName('Foo');
+
+        $this->entityManager
+            ->method('contains')
+            ->with($project)
+            ->willReturn(true);
+        $this->repository
+            ->method('findBy')
+            ->willReturn([$project]);
+        $this->classMetadata
+            ->method('getIdentifierValues')
+            ->with($project)
+            ->willReturn(['id' => $project->getId()]);
+
+        $form = $this->factory->create(CrudAutocompleteType::class, null, [
+            'class' => Project::class,
+            'choice_label' => static fn (Project $p): string => sprintf('[%d] %s', $p->getId(),
+                $p->getName()),
+        ]);
+        $form->submit(['autocomplete' => '123']);
+
+        $this->assertTrue($form->isSynchronized());
+
+        $view = $form->createView();
+
+        // the user-supplied callable is used to build the option label,
+        // overriding the default Project::__toString() output
+        $this->assertEquals(
+            ['123' => new ChoiceView($project, 123, '[123] Foo')],
+            $view->children['autocomplete']->vars['choices'],
+        );
+    }
+
+    public function testAutocompleteCallbackStillWinsWhenChoiceLabelIsNotSet(): void
+    {
+        $project = (new Project())->setId(123)->setName('Foo');
+
+        $this->entityManager
+            ->method('contains')
+            ->with($project)
+            ->willReturn(true);
+        $this->repository
+            ->method('findBy')
+            ->willReturn([$project]);
+        $this->classMetadata
+            ->method('getIdentifierValues')
+            ->with($project)
+            ->willReturn(['id' => $project->getId()]);
+
+        $form = $this->factory->create(CrudAutocompleteType::class, null, [
+            'class' => Project::class,
+            'autocomplete_callback' => static fn (Project $p): string => 'cb:'.$p->getName(),
+        ]);
+        $form->submit(['autocomplete' => '123']);
+
+        $view = $form->createView();
+
+        $this->assertEquals(
+            ['123' => new ChoiceView($project, 123, 'cb:Foo')],
+            $view->children['autocomplete']->vars['choices'],
+        );
+    }
+
+    public function testChoiceLabelOptionRejectsInvalidType(): void
+    {
+
+        $this->expectException(\Symfony\Component\OptionsResolver\Exception\InvalidOptionsException::class);
+
+        $this->factory->create(CrudAutocompleteType::class, null, [
+            'class' => Project::class,
+            'choice_label' => 42, // int is not in the allowed types
+        ]);
+    }
 }