adding search

Author: bdelamatre

src/DataTableComponent.php

@@ -123,15 +123,19 @@ public function rowsQuery(): Builder
     {
         $this->cleanFilters();
 
-        return $this->applySorting($this->query());
-    }
+        $query = $this->query();
 
-    /**
-     * @return Builder
-     */
-    public function getRowsQueryProperty(): Builder
-    {
-        return $this->rowsQuery();
+        // sorting?
+        if (method_exists($this, 'applySorting')) {
+            $query = $this->applySorting($query);
+        }
+
+        // searching?
+        if (method_exists($this, 'applySearchFilter')) {
+            $query = $this->applySearchFilter($query);
+        }
+
+        return $query;
     }
 
     /**

src/Traits/WithFilters.php

@@ -2,6 +2,10 @@
 
 namespace Rappasoft\LaravelLivewireTables\Traits;
 
+use Illuminate\Database\Eloquent\Builder;
+use Rappasoft\LaravelLivewireTables\Utilities\ColumnUtilities;
+use Rappasoft\LaravelLivewireTables\Views\Column;
+
 /**
  * Trait WithFilters.
  */
@@ -183,4 +187,75 @@ public function getFilterOptions(string $filter): array
     {
         return array_filter(array_keys($this->filters()[$filter]->options() ?? []));
     }
+
+    /**
+     * Collects columns with $searchable = true
+     *
+     * @return Column[]
+     */
+    public function getSearchableColumns() : array
+    {
+        return array_filter($this->columns(), function(Column $column) {
+            return $column->isSearchable();
+        });
+    }
+
+    /**
+     * Apply Search Filter
+     *
+     * @param Builder $query
+     * @return Builder
+     */
+    public function applySearchFilter(Builder $query): Builder
+    {
+        if ($this->hasFilter('search')) {
+
+            // get search value
+            $search = $this->getFilter('search');
+
+            // trim
+            $search = trim($search);
+
+            // group search conditions together
+            $query->where(function (Builder $subQuery) use ($search, $query) {
+
+                foreach ($this->getSearchableColumns() as $column) {
+
+                    // does this column have an alias or relation?
+                    $hasRelation = ColumnUtilities::hasRelation($column->column());
+
+                    // let's try to map this column to a selected column
+                    $selectedColumn = ColumnUtilities::mapToSelected($column->column(), $query);
+
+                    // if the column has a search callback, just use that
+                    if ($column->searchCallback) {
+
+                        // call the callback
+                        ($column->searchCallback)($query, $search);
+
+                    // if the column isn't a relation or if it was previously selected
+                    } elseif (! $hasRelation || $selectedColumn) {
+
+                        // we can use a simple where clause
+                        $subQuery->orWhere($selectedColumn ?? $column->column(), 'like', '%' . $search . '%');
+
+                    } else {
+
+                        // parse the column
+                        $relationName = ColumnUtilities::parseRelation($column->column());
+                        $fieldName = ColumnUtilities::parseField($column->column());
+
+                        // we use whereHas which can work with unselected relations
+                        $subQuery->orWhereHas($relationName, function (Builder $hasQuery) use ($fieldName, $column, $search) {
+                            $hasQuery->where($fieldName, 'like', '%' . $search . '%');
+                        });
+
+                    }
+                }
+            });
+
+        }
+
+        return $query;
+    }
 }

src/Views/Column.php

@@ -29,6 +29,16 @@ class Column
      */
     public $sortCallback;
 
+    /**
+     * @var bool
+     */
+    public bool $searchable = false;
+
+    /**
+     * @var callable
+     */
+    public $searchCallback;
+
     /**
      * @var string|null
      */
@@ -97,6 +107,14 @@ public function isSortable(): bool
         return $this->sortable === true;
     }
 
+    /**
+     * @return bool
+     */
+    public function isSearchable(): bool
+    {
+        return $this->searchable === true;
+    }
+
     /**
      * @return bool
      */
@@ -117,6 +135,19 @@ public function sortable($callback = null): self
         return $this;
     }
 
+    /**
+     * @param callable|null $callback
+     * @return $this
+     */
+    public function searchable(callable $callback = null): self
+    {
+        $this->searchable = true;
+
+        $this->searchCallback = $callback;
+
+        return $this;
+    }
+
     /**
      * @param string $class
      *