[Autocomplete] Let the EntityAutocompleter drive results creation, so that extra options may be exposed for tom-select to use them

Author: J-Ben87

src/Autocomplete/CHANGELOG.md

@@ -4,6 +4,7 @@
 
 -   Deprecate `ExtraLazyChoiceLoader` in favor of `Symfony\Component\Form\ChoiceList\Loader\LazyChoiceLoader`
 -   Reset TomSelect when updating url attribute #1505
+-   Let the EntityAutocompleter drive results creation, so that extra options may be exposed for tom-select to use them
 
 ## 2.22.0
 

src/Autocomplete/src/AutocompleteResultsExecutor.php

@@ -73,10 +73,7 @@ public function fetchResults(EntityAutocompleterInterface $autocompleter, string
 
         if (!method_exists($autocompleter, 'getGroupBy') || null === $groupBy = $autocompleter->getGroupBy()) {
             foreach ($paginator as $entity) {
-                $results[] = [
-                    'value' => $autocompleter->getValue($entity),
-                    'text' => $autocompleter->getLabel($entity),
-                ];
+                $results[] = $autocompleter->getResult($entity);
             }
 
             return new AutocompleteResults($results, $hasNextPage);
@@ -104,10 +101,7 @@ public function fetchResults(EntityAutocompleterInterface $autocompleter, string
         $optgroupLabels = [];
 
         foreach ($paginator as $entity) {
-            $result = [
-                'value' => $autocompleter->getValue($entity),
-                'text' => $autocompleter->getLabel($entity),
-            ];
+            $result = $autocompleter->getResult($entity);
 
             $groupLabels = $groupBy($entity, $result['value'], $result['text']);
 

src/Autocomplete/src/EntityAutocompleterInterface.php

@@ -52,6 +52,14 @@ public function getLabel(object $entity): string;
      */
     public function getValue(object $entity): mixed;
 
+    /**
+     * Returns the autocomplete result, usually the label as "text" and the value as "value".
+     * May be used to expose extra options such as "disabled" so that tom-select's rendering may be customized.
+     *
+     * @param T $entity
+     */
+    public function getResult(object $entity): array;
+
     /**
      * Return true if access should be granted to the autocomplete results for the current user.
      *

src/Autocomplete/src/Form/WrappedEntityTypeAutocompleter.php

@@ -114,6 +114,14 @@ public function getValue(object $entity): string
         return $this->getEntityMetadata()->getIdValue($entity);
     }
 
+    public function getResult(object $entity): array
+    {
+        return [
+            'value' => $this->getValue($entity),
+            'text' => $this->getLabel($entity),
+        ];
+    }
+
     public function isGranted(Security $security): bool
     {
         $securityOption = $this->getForm()->getConfig()->getOption('security');

src/Autocomplete/tests/Fixtures/Autocompleter/CustomProductAutocompleter.php

@@ -61,6 +61,14 @@ public function getValue(object $entity): mixed
         return $entity->getId();
     }
 
+    public function getResult(object $entity): array
+    {
+        return [
+            'text' => $this->getLabel($entity),
+            'value' => $this->getValue($entity),
+        ];
+    }
+
     public function isGranted(Security $security): bool
     {
         if ($this->requestStack->getCurrentRequest()?->query->get('enforce_test_security')) {