add general search

Author: AsemAlalami

README.md

@@ -51,10 +51,13 @@ class Order extends Model
         $this->addFields(['source', 'subsource', 'order_date']);
         // field from relation
         $this->addFields(['channel.created_at' => 'channel_create'])->setDatatype('date');
+        $this->addField('orderLines.product.sku', 'product_sku');
         // field from relation count
         $this->addCountField('orderLines');
         // custom field (raw sql)
         $this->addCustomField('my_total', '(shipping_cost + subtotal)');
+        // enable general search
+        $this->addGeneralSearch(['source', 'orderLines.product.sku'], 'startsWith');
     }
 
     // customize field filter by custom scope
@@ -167,6 +170,12 @@ You can add fields to a model by using 4 functions:
     $this->addCustomField('line_subtotal', '(`price` + `quantity`)', 'orderLines'); // inside "orderLines" relation
     ```
 
+## General Search
+You can enable general search on some fields, and you can specify the operator (`startsWith` is the default operator)
+```php
+$this->addGeneralSearch(['source', 'orderLines.product.sku'], 'startsWith');
+```
+
 ## Conjunction
 Currently, the package support one conjunction between all fields
 `and` | `or`, default conjunction attribute in the config file `default_conjunction`

phpunit.xml

@@ -20,11 +20,11 @@
         </whitelist>
     </filter>
     <php>
-        <env name="DB_CONNECTION" value="sqlite"/>
-        <env name="DB_DATABASE" value=":memory:"/>
-        <!--        <env name="DB_CONNECTION" value="mysql"/>-->
-        <!--        <env name="DB_DATABASE" value="advanced_filter"/>-->
-        <!--        <env name="DB_PASSWORD" value="password"/>-->
+        <!--        <env name="DB_CONNECTION" value="sqlite"/>-->
+        <!--        <env name="DB_DATABASE" value=":memory:"/>-->
+        <env name="DB_CONNECTION" value="mysql"/>
+        <env name="DB_DATABASE" value="advanced_filter"/>
+        <env name="DB_PASSWORD" value="password"/>
         <env name="DB_USERNAME" value="root"/>
         <env name="DB_PORT" value="3306"/>
         <env name="CACHE_DRIVER" value="array"/>

src/Fields/HasFields.php

@@ -87,7 +87,7 @@ public function addCustomField(string $alias, string $sqlRaw, $relation = null)
 
     public function addGeneralSearch(array $fields, string $operator = null)
     {
-        $this->generalSearch = ['fields' => $fields, $operator => $operator];
+        $this->generalSearch = ['fields' => $fields, 'operator' => $operator];
     }
 
     /**

src/HasFilter.php

@@ -92,7 +92,7 @@ private function applyGeneralSearch(Builder $builder, FilterRequest $filterReque
                 foreach ($this->generalSearch['fields'] as $fieldName) {
                     $field = new Field($builder->getModel(), $fieldName);
 
-                    $this->filterField($builder, $field, $operator, $filterRequest->getGeneralSearch());
+                    $this->filterField($builder, $field, $operator, $filterRequest->getGeneralSearch(), 'or');
                 }
             });
         }

tests/GeneralSearchTest.php

@@ -0,0 +1,24 @@
+<?php
+
+
+namespace AsemAlalami\LaravelAdvancedFilter\Test;
+
+
+use AsemAlalami\LaravelAdvancedFilter\Test\Models\Order;
+use Illuminate\Http\Request;
+
+class GeneralSearchTest extends TestCase
+{
+    /** @test */
+    public function general_search()
+    {
+        $queryFilters = 'query=64759';
+        $request = Request::create("test?{$queryFilters}");
+
+        $orders = Order::filter($request)->get();
+
+        $this->assertCount(2, $orders);
+
+        $this->assertEquals(['LAF_0002', 'LAF_0003'], $orders->pluck('reference')->toArray());
+    }
+}

tests/Models/Order.php

@@ -62,5 +62,7 @@ public function setupFilter()
         $this->addField('orderLines.product_id', 'product_id');
         $this->addField('orderLines.product.name', 'product_name');
         $this->addField('orderLines.product.sku', 'product_sku');
+
+        $this->addGeneralSearch(['reference', 'orderLines.product.sku']);
     }
 }