Fixed global search key bug

Author: Obrainwave

README.md

@@ -13,7 +13,7 @@ composer require obrainwave/laravel-query-filters
 Publish the config (optional):
 
 ```bash
-php artisan vendor:publish --provider="Obrainwave\LaravelQueryFilters\LaravelQueryFiltersServiceProvider" --tag="query-filters-config"
+php artisan vendor:publish --tag=query-filters-config
 ```
 
 ---
@@ -27,12 +27,7 @@ return [
 
     'global_key' => 'q', // Query parameter key for global search
 
-    'allowed_filters' => [
-        'status',
-        'role',
-        'email',
-        'created_at',
-    ],
+    'allowed_filters' => ['name', 'role'],
 
     'default_match' => 'exact', // exact, like, strict
 
@@ -44,7 +39,7 @@ return [
     ],
 
     'pagination' => [
-        'per_page' => 15,
+        'per_page' => 10,
         'max_per_page' => 100,
     ],
 

config/query-filters.php

@@ -20,7 +20,29 @@
     | You can also override per model via $globalSearchKey property.
     |
     */
-    'global_key' => 'q',
+    'global_key'           => 'q',
+
+    /*
+    |--------------------------------------------------------------------------
+    | Strict Global Search
+    |--------------------------------------------------------------------------
+    |
+    | This option controls how the package handles global search columns.
+    |
+    | - When set to false (default), the filter will silently ignore any
+    |   invalid or non-existent columns. This is useful when you want the
+    |   search to "just work" without throwing errors.
+    |
+    | - When set to true, the filter will throw an exception if you define
+    |   a global search column that does not exist on the model’s table.
+    |   (Fallback columns like name, title, body, etc. are automatically
+    |   validated against the schema and will never throw errors.)
+    |
+    | This gives you the flexibility to decide between convenience and
+    | strict validation depending on your project’s needs.
+    |
+    */
+    'strict_global_search' => false,
 
     /*
     |--------------------------------------------------------------------------
@@ -33,11 +55,11 @@
     |   /users?status=active&role=admin
     |
     */
-    'allowed_filters' => [
-        'status',
-        'role',
-        'email',
-        'created_at',
+    'allowed_filters'      => [
+        // 'status',
+        // 'role',
+        // 'email',
+        // 'created_at',
     ],
 
     /*
@@ -55,7 +77,7 @@
     |   /users?name=John&mode=like => partial match if mode is changed
     |
     */
-    'default_match' => 'exact',
+    'default_match'        => 'exact',
 
     /*
     |--------------------------------------------------------------------------
@@ -75,7 +97,7 @@
     |   'user.*' => 'like'         // wildcard on all user columns
     |
     */
-    'filter_modes' => [
+    'filter_modes'         => [
         // 'email'    => 'strict',
         // 'name'     => 'like',
         // 'user.*'   => 'like',
@@ -94,8 +116,8 @@
     |   Config fallback if none specified
     |
     */
-    'pagination' => [
-        'per_page' => 1,   // default items per page
+    'pagination'           => [
+        'per_page'     => 10,   // default items per page
         'max_per_page' => 100, // maximum items allowed per page
     ],
 
@@ -113,9 +135,9 @@
     |   'allowed_columns' => ['name', 'created_at']
     |
     */
-    'sorting' => [
+    'sorting'              => [
         'allowed_columns' => [],   // empty = all allowed
-        'default' => null, // e.g., 'created_at' or '-created_at'
+        'default'         => null, // e.g., 'created_at' or '-created_at'
     ],
 
     /*
@@ -135,7 +157,7 @@
     | Disable by setting 'enabled' => false
     |
     */
-    'operators' => [
+    'operators'            => [
         'enabled' => true,
     ],
 

src/Concerns/HandlesGlobalSearch.php

@@ -1,5 +1,4 @@
 <?php
-
 namespace Obrainwave\LaravelQueryFilters\Concerns;
 
 trait HandlesGlobalSearch
@@ -21,23 +20,47 @@ protected function getGlobalSearchKey(): string
 
     protected function applyGlobalSearch(string $term): void
     {
-        $term = strtolower($term);
-        $model = $this->builder->getModel();
+        $term       = strtolower($term);
+        $model      = $this->builder->getModel();
+        $allColumns = \Schema::getColumnListing($model->getTable());
 
         if ($model && method_exists($model, 'getGlobalSearchColumns')) {
             $columns = $model->getGlobalSearchColumns();
-        } elseif ($model && property_exists($model, 'globalSearchColumns') &&
+        } elseif (
+            $model &&
+            property_exists($model, 'globalSearchColumns') &&
             is_array($model->globalSearchColumns) &&
-            ! empty($model->globalSearchColumns)) {
+            ! empty($model->globalSearchColumns)
+        ) {
             $columns = $model->globalSearchColumns;
         } else {
-            $columns = ['name', 'title', 'content', 'body', 'message', 'subject'];
+            $columns = array_intersect(
+                ['name', 'title', 'content', 'body', 'message', 'subject'],
+                $allColumns
+            );
+           
         }
 
-        $this->builder->where(function ($query) use ($term, $columns) {
-            foreach ($columns as $column) {
-                $query->orWhereRaw("LOWER({$column}) LIKE ?", ["%{$term}%"]);
+        $strict = config('queryfilters.strict_global_search', false);
+
+        $validColumns = [];
+        foreach ($columns as $column) {
+            if (\Schema::hasColumn($model->getTable(), $column)) {
+                $validColumns[] = $column;
+            } elseif ($strict) {
+                throw new \InvalidArgumentException(
+                    "Global search column '{$column}' does not exist on table '{$model->getTable()}'"
+                );
             }
-        });
+        }
+
+        if (! empty($validColumns)) {
+            $this->builder->where(function ($query) use ($term, $validColumns) {
+                foreach ($validColumns as $column) {
+                    $query->orWhereRaw("LOWER({$column}) LIKE ?", ["%{$term}%"]);
+                }
+            });
+        }
     }
+
 }