- adds 'selection' ability for global controls

- selection works only on selectable table, and will send to the BE a selection payload with the selected rows
- buttons that work with selection will be rendered only when a selection is made

Author: aocneanu

src/Attributes/Button.php

@@ -9,7 +9,7 @@ class Button
     public const Optional = [
         'action', 'confirmation', 'event', 'fullRoute', 'label',  'message',
         'method', 'params', 'postEvent', 'routeSuffix', 'tooltip', 'slot',
-        'class', 'name',
+        'class', 'name', 'selection',
     ];
 
     public const Actions = ['ajax', 'export', 'href', 'router'];

src/Exceptions/Button.php

@@ -80,4 +80,18 @@ public static function invalidMethod(string $method)
             ['method' => $method]
         ));
     }
+
+    public static function noSelectable()
+    {
+        return new static(__(
+            "You can't have an action with selection when the table is not selectable",
+        ));
+    }
+
+    public static function rowSelection()
+    {
+        return new static(__(
+            'Selection works only on global buttons',
+        ));
+    }
 }

src/Services/Template/Validators/Buttons/Button.php

@@ -14,18 +14,19 @@ class Button
 {
     private const Validations = [
         'mandatory', 'optional', 'complementary',
-        'actions', 'method', 'name', 'route',
+        'actions', 'method', 'name', 'route', 'selection',
     ];
 
     private Obj $button;
+    private Obj $template;
     private Table $table;
     private ?string $routePrefix;
 
-    public function __construct(Obj $button, Table $table, ?string $routePrefix)
+    public function __construct(Obj $button, Table $table, Obj $template)
     {
         $this->button = $button;
         $this->table = $table;
-        $this->routePrefix = $routePrefix;
+        $this->template = $template;
     }
 
     public function validate(): void
@@ -94,7 +95,7 @@ private function route(): void
         $route = $this->button->get('fullRoute');
 
         $route ??= $this->button->has('routeSuffix')
-            ? "{$this->routePrefix}.{$this->button->get('routeSuffix')}"
+            ? "{$this->template->get('routePrefix')}.{$this->button->get('routeSuffix')}"
             : null;
 
         if ($route !== null && ! Route::has($route)) {
@@ -121,4 +122,19 @@ private function name(): void
             throw Exception::missingName();
         }
     }
+
+    private function selection(): void
+    {
+        if (! $this->button->get('selection')) {
+            return;
+        }
+
+        if ($this->button->get('type') === 'row') {
+            throw Exception::rowSelection();
+        }
+
+        if (! $this->template->get('selectable')) {
+            throw Exception::noSelectable();
+        }
+    }
 }

src/Services/Template/Validators/Buttons/Buttons.php

@@ -13,14 +13,12 @@ class Buttons
     private const Validations = ['format', 'defaults', 'structure'];
 
     private Obj $buttons;
-    private string $routePrefix;
     private Obj $defaults;
     private Table $table;
 
     public function __construct(Obj $template, Table $table)
     {
-        $this->buttons = $template->get('buttons');
-        $this->routePrefix = $template->get('routePrefix');
+        $this->template = $template;
         $this->table = $table;
         $this->defaults = $this->configButtons();
     }
@@ -33,7 +31,7 @@ public function validate(): void
 
     private function format(): void
     {
-        $invalid = $this->buttons
+        $invalid = $this->template->get('buttons')
             ->filter(fn ($button) => ! is_string($button) && ! $button instanceof Obj);
 
         if ($invalid->isNotEmpty()) {
@@ -43,7 +41,8 @@ private function format(): void
 
     private function defaults(): void
     {
-        $diff = $this->buttons->filter(fn ($button) => is_string($button))
+        $diff = $this->template->get('buttons')
+            ->filter(fn ($button) => is_string($button))
             ->diff($this->defaults->keys());
 
         if ($diff->isNotEmpty()) {
@@ -53,8 +52,9 @@ private function defaults(): void
 
     private function structure(): void
     {
-        $this->buttons->map(fn ($button) => $this->map($button))
-            ->each(fn ($button) => (new Button($button, $this->table, $this->routePrefix))
+        $this->template->get('buttons')
+            ->map(fn ($button) => $this->map($button))
+            ->each(fn ($button) => (new Button($button, $this->table, $this->template))
                 ->validate());
     }