Merge branch 'feature/sorting-callbacks' into develop

Author: rappasoft

CHANGELOG.md

@@ -6,6 +6,7 @@ All notable changes to `laravel-livewire-tables` will be documented in this file
 
 ### Added
 
+- Added callback to column's sortable() method to customize sorting functionality per column.
 - Support for polling `keep-alive` and `visible`.
 
 ### Changed

README.md

@@ -192,9 +192,9 @@ public function columns(): array
     {
         return [
             Column::make('Type') // Column text and optional column name, column name will be snake case of text if not defined
-                ->sortable() // Whether or not the heading can be clicked to sort
+                ->sortable(), // Whether or not the heading can be clicked to sort
             Column::make('Name')
-                ->sortable()
+                ->sortable(),
             Column::make('Permissions'),
             Column::make('Other', 'my_other_column')
                 ->sortable() // Allows the column to interact with the sorting methods
@@ -204,6 +204,17 @@ public function columns(): array
     }
 ```
 
+#### Customizing Sort Behavior
+
+If you need more control over the sort behavior of a column, you can pass a callback to the sortable() method:
+
+```php
+Column::make(__('Address'))
+    ->sortable(function(Builder $query, $direction) {
+        return $query->orderBy(UserAttribute::select('address')->whereColumn('user_attributes.user_id', 'users.id'), $direction);
+    })
+```
+
 #### Configuring Sort Names
 
 When clicking sortable column headers, the component will use the column name to define the sorting pill in the UI, if you don't like the way the name is rendered, you can overwrite it:

src/DataTableComponent.php

@@ -190,4 +190,18 @@ public function render()
                 'rows' => $this->rows,
             ]);
     }
+
+    /**
+     * Get a column object by its field
+     *
+     * @param  string  $column
+     *
+     * @return mixed
+     */
+    protected function getColumn(string $column)
+    {
+        return collect($this->columns())
+            ->where('column', $column)
+            ->first();
+    }
 }

src/Traits/WithSorting.php

@@ -30,7 +30,11 @@ public function sortBy(string $field): ?string
     public function applySorting(Builder $query): Builder
     {
         foreach ($this->sorts as $field => $direction) {
-            $query->orderBy($field, $direction);
+            if (optional($this->getColumn($field))->hasSortCallback()) {
+                $query = app()->call($this->getColumn($field)->getSortCallback(), ['query' => $query, 'direction' => $direction]);
+            } else {
+                $query->orderBy($field, $direction);
+            }
         }
 
         return $query;

src/Views/Column.php

@@ -24,6 +24,11 @@ class Column
      */
     public bool $sortable = false;
 
+    /**
+     * @var
+     */
+    public $sortCallback;
+
     /**
      * @var string|null
      */
@@ -103,10 +108,12 @@ public function isBlank(): bool
     /**
      * @return $this
      */
-    public function sortable(): self
+    public function sortable($callback = null): self
     {
         $this->sortable = true;
 
+        $this->sortCallback = $callback;
+
         return $this;
     }
 
@@ -192,4 +199,20 @@ public function formatted($row, $column = null)
 
         return $value;
     }
+
+    /**
+     * @return bool
+     */
+    public function hasSortCallback(): bool
+    {
+        return $this->sortCallback !== null;
+    }
+
+    /**
+     * @return callable|null
+     */
+    public function getSortCallback(): ?callable
+    {
+        return $this->sortCallback;
+    }
 }