v3.4.15 (#1893)

## [v3.4.15] - 2024-08-25 ### New Features - BooleanColumn - Toggleable Callback by @lrljoe in #1892 ### Tweaks - Doc Type Fixes by @lrljoe in #1891
rappasoft · Aug 25, 2024 · d140f39 · d140f39
1 parent ecf1fee
commit d140f39
Show file tree

Hide file tree

Showing 26 changed files with 221 additions and 97 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,13 @@
 
 All notable changes to `laravel-livewire-tables` will be documented in this file
 
+## [v3.4.15] - 2024-08-25
+### New Features
+- BooleanColumn - Toggleable Callback by @lrljoe in https://github.com/rappasoft/laravel-livewire-tables/pull/1892
+
+### Tweaks
+- Doc Type Fixes by @lrljoe in https://github.com/rappasoft/laravel-livewire-tables/pull/1891
+
 ## [v3.4.14] - 2024-08-25
 ### New Features
 - Set Action Position (Left/Center/Right) and Set Actions in Toolbar by @lrljoe in https://github.com/rappasoft/laravel-livewire-tables/pull/1889

diff --git a/docs/column-types/boolean_columns.md b/docs/column-types/boolean_columns.md
@@ -80,6 +80,46 @@ BooleanColumn::make('Active')
     ->yesNo()
 ```
 
+### Toggleable
+
+You may call a defined public function, which should live within your Table Component, to allow "toggling" against your database:
+
+```php
+BooleanColumn::make('Active', 'status')
+    ->toggleable('changeStatus'),
+```
+
+Then your "changeStatus" method may look like
+```php
+    public function changeStatus(int $id)
+    {
+        $item = $this->model::find($id);
+        $item->status = !$item->status;
+        $item->save();
+    }
+```
+
+### Toggleable Confirmation Message
+
+You may define a confirmation message prior to executing your toggleable() method.  The method will only be executed upon confirming.
+```php
+BooleanColumn::make('Active', 'status')
+    ->confirmMessage('Are you sure that you want to change the status?')
+    ->toggleable('changeStatus'),
+```
+
+Then your "changeStatus" method may look like
+```php
+    public function changeStatus(int $id)
+    {
+        $item = $this->model::find($id);
+        $item->status = !$item->status;
+        $item->save();
+    }
+```
+
+
+### Additional Methods
 Please also see the following for other available methods:
 <ul>
     <li>

diff --git a/resources/views/includes/columns/boolean.blade.php b/resources/views/includes/columns/boolean.blade.php
@@ -1,40 +1,27 @@
-@if ($isTailwind)
-    @if ($status)
-        @if ($type === 'icons')
-            @if ($successValue === true)
-                <x-heroicon-o-check-circle class="inline-block h-5 w-5 text-green-500" />
-            @else
-                <x-heroicon-o-check-circle class="inline-block h-5 w-5 text-red-500" />
-            @endif
-        @elseif ($type === 'yes-no')
-            @if ($successValue === true)
-                <span>Yes</span>
-            @else
-                <span>No</span>
-            @endif
-        @endif
-    @else
-        @if ($type === 'icons')
-            @if ($successValue === false)
-                <x-heroicon-o-x-circle class="inline-block h-5 w-5 text-green-500" />
-            @else
-                <x-heroicon-o-x-circle class="inline-block h-5 w-5 text-red-500" />
-            @endif
-        @elseif ($type === 'yes-no')
-            @if ($successValue === false)
-                <span>Yes</span>
-            @else
-                <span>No</span>
-            @endif
-        @endif
-    @endif
-@elseif ($isBootstrap)
+@if($isToggleable && $toggleMethod != '')
+    <button wire:click="{{ $toggleMethod }}('{{ $rowPrimaryKey }}')" 
+    @if($hasConfirmMessage) wire:confirm="{{ $confirmMessage }}" @endif
+>
+@endif
     @if ($status)
         @if ($type === 'icons')
             @if ($successValue === true)
-                <x-heroicon-o-check-circle  class="d-inline-block text-success laravel-livewire-tables-btn-small" />
-            @else
-                <x-heroicon-o-check-circle class="d-inline-block text-danger laravel-livewire-tables-btn-small" />
+                <x-heroicon-o-check-circle 
+                    @class(
+                        [
+                            "inline-block h-5 w-5 text-green-500" => $isTailwind,
+                            "d-inline-block text-success laravel-livewire-tables-btn-small" => $isBootstrap
+                        ]
+                    ) 
+                />
+            @else
+                <x-heroicon-o-check-circle @class(
+                        [
+                            "inline-block h-5 w-5 text-red-500" => $isTailwind,
+                            "d-inline-block text-danger laravel-livewire-tables-btn-small" => $isBootstrap
+                        ]
+                    )
+                />
             @endif
         @elseif ($type === 'yes-no')
             @if ($successValue === true)
@@ -46,9 +33,21 @@
     @else
         @if ($type === 'icons')
             @if ($successValue === false)
-                <x-heroicon-o-x-circle class="d-inline-block text-success laravel-livewire-tables-btn-small" />
-            @else
-                <x-heroicon-o-x-circle class="d-inline-block text-danger laravel-livewire-tables-btn-small" />
+                <x-heroicon-o-x-circle @class(
+                        [
+                            "inline-block h-5 w-5 text-green-500" => $isTailwind,
+                            "d-inline-block text-success laravel-livewire-tables-btn-small" => $isBootstrap
+                        ]
+                    )  
+                />
+            @else
+                <x-heroicon-o-x-circle @class(
+                        [
+                            "inline-block h-5 w-5 text-red-500" => $isTailwind,
+                            "d-inline-block text-danger laravel-livewire-tables-btn-small" => $isBootstrap
+                        ]
+                    ) 
+                />
             @endif
         @elseif ($type === 'yes-no')
             @if ($successValue === false)
@@ -58,4 +57,6 @@
             @endif
         @endif
     @endif
+@if($isToggleable && $toggleMethod != '')
+    </button>
 @endif
diff --git a/src/Traits/Configuration/FooterConfiguration.php b/src/Traits/Configuration/FooterConfiguration.php
@@ -46,14 +46,14 @@ public function setUseHeaderAsFooterDisabled(): self
         return $this;
     }
 
-    public function setFooterTrAttributes(callable $callback): self
+    public function setFooterTrAttributes(\Closure $callback): self
     {
         $this->footerTrAttributesCallback = $callback;
 
         return $this;
     }
 
-    public function setFooterTdAttributes(callable $callback): self
+    public function setFooterTdAttributes(\Closure $callback): self
     {
         $this->footerTdAttributesCallback = $callback;
 

diff --git a/src/Traits/Configuration/SecondaryHeaderConfiguration.php b/src/Traits/Configuration/SecondaryHeaderConfiguration.php
@@ -25,14 +25,14 @@ public function setSecondaryHeaderDisabled(): self
         return $this;
     }
 
-    public function setSecondaryHeaderTrAttributes(callable $callback): self
+    public function setSecondaryHeaderTrAttributes(\Closure $callback): self
     {
         $this->secondaryHeaderTrAttributesCallback = $callback;
 
         return $this;
     }
 
-    public function setSecondaryHeaderTdAttributes(callable $callback): self
+    public function setSecondaryHeaderTdAttributes(\Closure $callback): self
     {
         $this->secondaryHeaderTdAttributesCallback = $callback;
 

diff --git a/src/Traits/Configuration/TableAttributeConfiguration.php b/src/Traits/Configuration/TableAttributeConfiguration.php
@@ -68,7 +68,7 @@ public function setTbodyAttributes(array $attributes = []): self
     /**
      * Set a list of attributes to override on the th elements
      */
-    public function setThAttributes(callable $callback): self
+    public function setThAttributes(\Closure $callback): self
     {
         $this->thAttributesCallback = $callback;
 
@@ -78,7 +78,7 @@ public function setThAttributes(callable $callback): self
     /**
      * Set a list of attributes to override on the th sort button elements
      */
-    public function setThSortButtonAttributes(callable $callback): self
+    public function setThSortButtonAttributes(\Closure $callback): self
     {
         $this->thSortButtonAttributesCallback = $callback;
 
@@ -88,7 +88,7 @@ public function setThSortButtonAttributes(callable $callback): self
     /**
      * Set a list of attributes to override on the td elements
      */
-    public function setTrAttributes(callable $callback): self
+    public function setTrAttributes(\Closure $callback): self
     {
         $this->trAttributesCallback = $callback;
 
@@ -98,21 +98,21 @@ public function setTrAttributes(callable $callback): self
     /**
      * Set a list of attributes to override on the td elements
      */
-    public function setTdAttributes(callable $callback): self
+    public function setTdAttributes(\Closure $callback): self
     {
         $this->tdAttributesCallback = $callback;
 
         return $this;
     }
 
-    public function setTableRowUrl(callable $callback): self
+    public function setTableRowUrl(\Closure $callback): self
     {
         $this->trUrlCallback = $callback;
 
         return $this;
     }
 
-    public function setTableRowUrlTarget(callable $callback): self
+    public function setTableRowUrlTarget(\Closure $callback): self
     {
         $this->trUrlTargetCallback = $callback;
 

diff --git a/src/Traits/Helpers/ConfigurableAreasHelpers.php b/src/Traits/Helpers/ConfigurableAreasHelpers.php
@@ -21,12 +21,9 @@ public function hasConfigurableAreaFor(string $area): bool
         return isset($this->configurableAreas[$area]) && $this->getConfigurableAreaFor($area) !== null;
     }
 
-    /**
-     * @param  string|array<mixed>  $area
-     */
-    public function getConfigurableAreaFor($area): ?string
+    public function getConfigurableAreaFor(string $area): ?string
     {
-        $area = $this->configurableAreas[$area] ?? null;
+        $area = array_key_exists($area, $this->configurableAreas) ? $this->configurableAreas[$area] : null;
 
         if (is_array($area)) {
             return $area[0];
@@ -35,13 +32,9 @@ public function getConfigurableAreaFor($area): ?string
         return $area;
     }
 
-    /**
-     * @param  string|array<mixed>  $area
-     * @return array<mixed>
-     */
-    public function getParametersForConfigurableArea($area): array
+    public function getParametersForConfigurableArea(string $area): array
     {
-        $area = $this->configurableAreas[$area] ?? null;
+        $area = array_key_exists($area, $this->configurableAreas) ? $this->configurableAreas[$area] : null;
 
         if (is_array($area) && isset($area[1]) && is_array($area[1])) {
             return $area[1];

diff --git a/src/Traits/Helpers/SearchHelpers.php b/src/Traits/Helpers/SearchHelpers.php
@@ -123,7 +123,11 @@ public function getSearchOptions(): string
 
     public function getSearchPlaceholder(): string
     {
-        return $this->hasSearchPlaceholder() ? $this->searchPlaceholder : __('Search');
+        if ($this->hasSearchPlaceholder()) {
+            return $this->searchPlaceholder;
+        }
+
+        return __('Search');
     }
 
     public function hasSearchPlaceholder(): bool

diff --git a/src/Traits/WithFooter.php b/src/Traits/WithFooter.php
@@ -16,9 +16,9 @@ trait WithFooter
 
     protected bool $columnsWithFooter = false;
 
-    protected ?object $footerTrAttributesCallback;
+    protected ?\Closure $footerTrAttributesCallback;
 
-    protected ?object $footerTdAttributesCallback;
+    protected ?\Closure $footerTdAttributesCallback;
 
     public function setupFooter(): void
     {

diff --git a/src/Traits/WithSecondaryHeader.php b/src/Traits/WithSecondaryHeader.php
@@ -14,9 +14,9 @@ trait WithSecondaryHeader
 
     protected bool $columnsWithSecondaryHeader = false;
 
-    protected ?object $secondaryHeaderTrAttributesCallback;
+    protected ?\Closure $secondaryHeaderTrAttributesCallback;
 
-    protected ?object $secondaryHeaderTdAttributesCallback;
+    protected ?\Closure $secondaryHeaderTdAttributesCallback;
 
     public function bootedWithSecondaryHeader(): void
     {

diff --git a/src/Traits/WithTableAttributes.php b/src/Traits/WithTableAttributes.php
@@ -21,15 +21,15 @@ trait WithTableAttributes
 
     protected array $tbodyAttributes = [];
 
-    protected ?object $thAttributesCallback;
+    protected ?\Closure $thAttributesCallback;
 
-    protected ?object $thSortButtonAttributesCallback;
+    protected ?\Closure $thSortButtonAttributesCallback;
 
-    protected ?object $trAttributesCallback;
+    protected ?\Closure $trAttributesCallback;
 
-    protected ?object $tdAttributesCallback;
+    protected ?\Closure $tdAttributesCallback;
 
-    protected ?object $trUrlCallback;
+    protected ?\Closure $trUrlCallback;
 
-    protected ?object $trUrlTargetCallback;
+    protected ?\Closure $trUrlTargetCallback;
 }
diff --git a/src/Views/Columns/BooleanColumn.php b/src/Views/Columns/BooleanColumn.php
@@ -7,12 +7,14 @@
 use Rappasoft\LaravelLivewireTables\Views\Column;
 use Rappasoft\LaravelLivewireTables\Views\Traits\Configuration\BooleanColumnConfiguration;
 use Rappasoft\LaravelLivewireTables\Views\Traits\Core\HasCallback;
+use Rappasoft\LaravelLivewireTables\Views\Traits\Core\HasConfirmation;
 use Rappasoft\LaravelLivewireTables\Views\Traits\Helpers\BooleanColumnHelpers;
 
 class BooleanColumn extends Column
 {
     use BooleanColumnConfiguration,
         BooleanColumnHelpers,
+        HasConfirmation,
         HasCallback;
 
     protected string $type = 'icons';
@@ -21,6 +23,10 @@ class BooleanColumn extends Column
 
     protected string $view = 'livewire-tables::includes.columns.boolean';
 
+    protected bool $isToggleable = false;
+
+    protected ?string $toggleMethod;
+
     public function getContents(Model $row): null|string|\Illuminate\Support\HtmlString|DataTableConfigurationException|\Illuminate\Contracts\Foundation\Application|\Illuminate\Contracts\View\Factory|\Illuminate\Contracts\View\View
     {
         if ($this->isLabel()) {
@@ -30,6 +36,11 @@ public function getContents(Model $row): null|string|\Illuminate\Support\HtmlStr
         $value = $this->getValue($row);
 
         return view($this->getView())
+            ->withRowPrimaryKey($row->{$row->getKeyName()})
+            ->withIsToggleable($this->getIsToggleable())
+            ->withToggleMethod($this->getIsToggleable() ? $this->getToggleMethod() : '')
+            ->withHasConfirmMessage($this->hasConfirmMessage())
+            ->withConfirmMessage($this->hasConfirmMessage() ? $this->getConfirmMessage() : '')
             ->withIsTailwind($this->isTailwind())
             ->withIsBootstrap($this->isBootstrap())
             ->withSuccessValue($this->getSuccessValue())

diff --git a/src/Views/Columns/ColorColumn.php b/src/Views/Columns/ColorColumn.php
@@ -17,7 +17,7 @@ class ColorColumn extends Column
         ColorColumnHelpers;
     use HasDefaultStringValue;
 
-    public ?object $colorCallback = null;
+    public ?\Closure $colorCallback;
 
     protected string $view = 'livewire-tables::includes.columns.color';