Sorting Callbacks

- Add callback to sortable()
- Add has/getSortCallback
- Utilize callback when sorting
- Add getColumn method

Author: rappasoft

src/DataTableComponent.php

@@ -16,11 +16,11 @@
  */
 abstract class DataTableComponent extends Component
 {
-    use WithBulkActions;
-    use WithCustomPagination;
-    use WithFilters;
-    use WithPerPagePagination;
-    use WithSorting;
+    use WithBulkActions,
+        WithCustomPagination,
+        WithFilters,
+        WithPerPagePagination,
+        WithSorting;
 
     /**
      * The default pagination theme.
@@ -190,4 +190,18 @@ public function render()
                 'rows' => $this->rows,
             ]);
     }
+
+    /**
+     * Get a column object by its field
+     *
+     * @param $column
+     *
+     * @return mixed
+     */
+    protected function getColumn($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(), ['builder' => $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 null
+     */
+    public $sortCallback;
+
     /**
      * @var string|null
      */
@@ -103,10 +108,14 @@ public function isBlank(): bool
     /**
      * @return $this
      */
-    public function sortable(): self
+    public function sortable(callable $callback = null): self
     {
         $this->sortable = true;
 
+        if ($callback) {
+            $this->sortCallback = $callback;
+        }
+
         return $this;
     }
 
@@ -192,4 +201,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;
+    }
 }