Drop SelectFilter template

Author: antoine

docs/guide/filters.md

@@ -209,50 +209,6 @@ public function buildFilterConfig(): void
 }
 ```
 
-## Filter template
-
-Sometimes you need your select filter results to be a little more than a label. For this, configure a template (similar to form fields with templates):
-
-```php
-public function buildFilterConfig(): void
-{
-    $this->configureTemplate('<div>{{label}}</div><div><small>{{detail}}</small></div>');
-}
-```
-
-You can also, for more control, return a view here.
-
-The template will be [interpreted by Vue.js](https://vuejs.org/v2/guide/syntax.html), meaning you can add data placeholders, DOM structure but also directives, and anything that Vue will parse. It's the same as [Autocomplete's templates](form-fields/autocomplete.md).
-
-You'll need also to change your `values()` function, returning more than an `[{id}=>{value}]` array. For instance:
-
-```php
-public function values()
-{
-    return ProductCategory::orderBy('label')
-        ->get()
-        ->map(function ($category) {
-            return [
-                'id' => $category->id,
-                'label' => $category->label,
-                'detail' => $category->detail_text
-            ];
-        });
-}
-```
-
-Note that **the label attribute is mandatory**: it is used for the result display of the filter.
-
-Finally, if your filter is also searchable, you'll need to configure attributes which should be searched in the template:
-
-```php
-public function buildFilterConfig(): void
-{
-    $this->configureSearchable()
-        ->configureSearchKeys(['label', 'detail']);
-}
-```
-
 ## Check filter
 
 In case of a filter that is just a matter on true / false ("only show admins" for example), just make your filter class extend `Code16\Sharp\EntityList\Filters\EntityListCheckFilter`.

docs/guide/upgrading/9.0.md

@@ -234,8 +234,6 @@ $instance: // the **Customer** instance
 $attribute: 'name'
 ```
 
-
-
 ### Thumbnails custom filters must be refactored to Modifiers
 
 First, if you defined custom filters classes for your thumbnails, you must refactor it to the new ThumbnailModifier API, which is very close:
@@ -472,6 +470,10 @@ class PostBlockList extends SharpEntityList
 
 You can of course instead declare a real Filter.
 
+### Select filter `configureTemplate()` has been dropped
+
+If you were using this method, you must do the string transformation in the label of each value.
+
 ### New performance optimization for Commands and Policies in Entity List (n+1)
 
 This is not a breaking change, in fact you can ignore this step entirely, but since it's can lead to a significative performance boost, this is worth mentioning: you can now quite easily implement a [caching mechanism of instances for your Commands and Policies in Entity List](../avoid-n1-queries-in-entity-lists.md).

src/Data/Filters/SelectFilterData.php

@@ -22,13 +22,12 @@ public function __construct(
         //        public mixed $default,
         public bool $multiple,
         public bool $required,
-        #[LiteralTypeScriptType('Array<{ id:string|number } & { [key: string]: any }>')]
+        #[LiteralTypeScriptType('Array<{ id: string|number } & { [key: string]: any }>')]
         public array $values,
         public bool $master,
         public bool $searchable,
         /** string[] */
         public array $searchKeys,
-        public string $template,
     ) {}
 
     public static function from(array $filter): self

src/Utils/Filters/Concerns/BuildsFiltersConfigArray.php

@@ -37,7 +37,6 @@ public function getFiltersConfigArray(): ?array
                                 'master' => $filterHandler->isMaster(),
                                 'searchable' => $filterHandler->isSearchable(),
                                 'searchKeys' => $filterHandler->getSearchKeys(),
-                                'template' => $filterHandler->getTemplate(),
                             ];
                         } elseif ($filterHandler instanceof DateRangeFilter) {
                             $filterConfigData += [

src/Utils/Filters/SelectFilter.php

@@ -7,7 +7,6 @@ abstract class SelectFilter extends Filter
     private bool $isMaster = false;
     private bool $isSearchable = false;
     private array $searchKeys = ['label'];
-    private string $template = '{{label}}';
 
     final public function isMaster(): bool
     {
@@ -24,11 +23,6 @@ final public function getSearchKeys(): array
         return $this->searchKeys;
     }
 
-    final public function getTemplate(): string
-    {
-        return $this->template;
-    }
-
     final public function configureSearchable(bool $isSearchable = true): self
     {
         $this->isSearchable = $isSearchable;
@@ -43,13 +37,6 @@ final public function configureSearchKeys(array $searchKeys): self
         return $this;
     }
 
-    final public function configureTemplate(string $template): self
-    {
-        $this->template = $template;
-
-        return $this;
-    }
-
     final public function configureMaster(bool $isMaster = true): self
     {
         $this->isMaster = $isMaster;

tests/Unit/Dashboard/DashboardFilterTest.php

@@ -44,7 +44,6 @@ public function values(): array
                     'master' => false,
                     'searchable' => false,
                     'searchKeys' => ['label'],
-                    'template' => '{{label}}',
                 ],
             ],
         ]);

tests/Unit/EntityList/SharpEntityListFilterTest.php

@@ -50,7 +50,6 @@ public function values(): array
                     'master' => false,
                     'searchable' => false,
                     'searchKeys' => ['label'],
-                    'template' => '{{label}}',
                 ],
             ],
         ]);
@@ -291,40 +290,6 @@ public function values(): array
     expect($list->listConfig()['filters']['_root'][0]['searchKeys'])->toEqual(['a', 'b']);
 });
 
-it('allows to define an inline template for a filter', function () {
-    $list = new class() extends FakeSharpEntityList
-    {
-        public function getFilters(): array
-        {
-            return [
-                new class() extends EntityListSelectFilter
-                {
-                    public function buildFilterConfig(): void
-                    {
-                        $this->configureTemplate('{{letter}} {{maj}}');
-                    }
-
-                    public function values(): array
-                    {
-                        return [
-                            ['id' => 1, 'letter' => 'a', 'maj' => 'A'],
-                            ['id' => 2, 'letter' => 'b', 'maj' => 'B'],
-                        ];
-                    }
-                },
-            ];
-        }
-    };
-
-    $list->buildListConfig();
-
-    expect($list->listConfig()['filters']['_root'][0]['template'])->toEqual('{{letter}} {{maj}}')
-        ->and($list->listConfig()['filters']['_root'][0]['values'])->toEqual([
-            ['id' => 1, 'letter' => 'a', 'maj' => 'A'],
-            ['id' => 2, 'letter' => 'b', 'maj' => 'B'],
-        ]);
-});
-
 it('allows to declare a filter as retained and to set its default value', function () {
     $list = new class() extends FakeSharpEntityList
     {