[Autocomplete] Define a method to combine basic attributes with extra attributes rather than allowing to override the result entirely

Author: J-Ben87

src/Autocomplete/CHANGELOG.md

@@ -4,7 +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
+-   Add a `getAttributes()` method to define extra attributes to add to the autocomplete result.
 
 ## 2.22.0
 

src/Autocomplete/src/AutocompleteResultsExecutor.php

@@ -73,7 +73,7 @@ public function fetchResults(EntityAutocompleterInterface $autocompleter, string
 
         if (!method_exists($autocompleter, 'getGroupBy') || null === $groupBy = $autocompleter->getGroupBy()) {
             foreach ($paginator as $entity) {
-                $results[] = self::getAutocompleterResult($autocompleter, $entity);
+                $results[] = $this->formatResult($autocompleter, $entity);
             }
 
             return new AutocompleteResults($results, $hasNextPage);
@@ -101,7 +101,7 @@ public function fetchResults(EntityAutocompleterInterface $autocompleter, string
         $optgroupLabels = [];
 
         foreach ($paginator as $entity) {
-            $result = self::getAutocompleterResult($autocompleter, $entity);
+            $result = $this->formatResult($autocompleter, $entity);
 
             $groupLabels = $groupBy($entity, $result['value'], $result['text']);
 
@@ -122,13 +122,15 @@ public function fetchResults(EntityAutocompleterInterface $autocompleter, string
     /**
      * @return array<string, mixed>
      */
-    private static function getAutocompleterResult(EntityAutocompleterInterface $autocompleter, object $entity): array
+    private function formatResult(EntityAutocompleterInterface $autocompleter, object $entity): array
     {
-        if (method_exists($autocompleter, 'getResult')) {
-            return $autocompleter->getResult($entity);
+        $attributes = [];
+        if (method_exists($autocompleter, 'getAttributes')) {
+            $attributes = $autocompleter->getAttributes($entity);
         }
 
         return [
+            ...$attributes,
             'value' => $autocompleter->getValue($entity),
             'text' => $autocompleter->getLabel($entity),
         ];

src/Autocomplete/src/EntityAutocompleterInterface.php

@@ -20,9 +20,8 @@
  *
  * @template T of object
  *
- * @method array getResults(object $entity) 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.
- * @method mixed getGroupBy()               Return group_by option.
+ * @method array getAttributes(object $entity) Returns extra attributes to add to the autocomplete result.
+ * @method mixed getGroupBy()                  Return group_by option.
  */
 interface EntityAutocompleterInterface
 {
@@ -55,10 +54,9 @@ 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.
+     * Returns extra attributes to add to the autocomplete result.
      */
-    /* public function getResult(object $entity): array; */
+    /* public function getAttributes(object $entity): array; */
 
     /**
      * Return true if access should be granted to the autocomplete results for the current user.

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

@@ -61,12 +61,9 @@ public function getValue(object $entity): mixed
         return $entity->getId();
     }
 
-    public function getResult(object $entity): array
+    public function getAttributes(object $entity): array
     {
-        return [
-            'text' => $this->getLabel($entity),
-            'value' => $this->getValue($entity),
-        ];
+        return [];
     }
 
     public function isGranted(Security $security): bool