Merge pull request #10 from adhenrique/develop

before search methods

Author: adhenrique

README.md

@@ -130,6 +130,49 @@ Route::delete('dummies/{id}', 'App\Http\Controllers\DummyController@destroy');
 ```
 
 ## Using
+### Before Search filters
+In the SearchService class you have two methods that help you to pre-start queries according to your needs: `beforeAll` and` beforeFindById`.
+Each method receives 2 parameters: `builder` with the Eloquent instance started and `auth`, with the user session - if are logged in.
+You just need to override the methods, but ensure that the return is eloquent's `Builder`. Look:
+```php
+class DummySearchService extends SearchService
+{
+    protected SearchModel $model;
+    protected FilterService $filterService;
+
+    public function __construct(DummySearchModel $model, DummyFilterService $filterService)
+    {
+        $this->model = $model;
+        $this->filterService = $filterService;
+    }
+
+    public function beforeAll(Builder $builder, Guard $auth): Builder
+    {
+        return $builder;
+    }
+
+    public function beforeFindById(Builder $builder, Guard $auth): Builder
+    {
+        return $builder;
+    }
+}
+```
+In my use case, logged in as admin, I usually filter from the list of users my own user. Look:
+```php
+// ...
+public function beforeAll(Builder $builder, Guard $auth): Builder
+{
+    return $this->removeLoggedFromSearches($builder, $auth);
+}
+
+private function removeLoggedFromSearches($builder, $auth)
+{
+    $id = $auth->id();
+    return $builder->where('id', '<>', $id);
+}
+```
+
+
 ### Searching with filters
 You can filter and paginate the data on the listing routes. To do this, send a payload on the request, using your favorite client:
 
@@ -185,6 +228,7 @@ You can filter and paginate the data on the listing routes. To do this, send a p
 - [ ] Support for old Laravel versions
 - [ ] Or Where filter
 - [ ] OOP improvements
+- [ ] Add beforeAll and beforeFindById tests
 
 ## Testing
 ```bash

src/Services/SearchService.php

@@ -22,7 +22,7 @@ public function __construct(SearchModel $model, FilterService $filterService)
 
     public function all(Request $request)
     {
-        $builder = $this->beforeSearch($this->model->query(), Auth::guard());
+        $builder = $this->beforeAll($this->model->query(), Auth::guard());
 
         $builder = $this->filterService->apply($builder, $request);
         $paginate = $request->get('paginate');
@@ -39,7 +39,7 @@ public function all(Request $request)
 
     public function findById(int $id)
     {
-        $builder = $this->beforeSearch($this->model->query(), Auth::guard());
+        $builder = $this->beforeFindById($this->model->query(), Auth::guard());
 
         return $builder->findOrFail($id);
     }
@@ -49,7 +49,12 @@ public function getTableName(): string
         return $this->model->getTable();
     }
 
-    public function beforeSearch(Builder $builder, Guard $auth): Builder
+    public function beforeAll(Builder $builder, Guard $auth): Builder
+    {
+        return $builder;
+    }
+
+    public function beforeFindById(Builder $builder, Guard $auth): Builder
     {
         return $builder;
     }