├── README.md
├── composer.json
└── src
    ├── EloquentFilterServiceProvider.php
    ├── Filterable.php
    └── QueryFilters.php


/README.md:
--------------------------------------------------------------------------------
  1 | # Laravel Eloquent Filter  
  2 | 
  3 |   [![Latest Stable Version](https://poser.pugx.org/nahidulhasan/eloquent-filter/v/stable)](https://packagist.org/packages/nahidulhasan/eloquent-filter)
  4 |    [![Total Downloads](https://poser.pugx.org/nahidulhasan/eloquent-filter/downloads)](https://packagist.org/packages/nahidulhasan/eloquent-filter)
  5 |   [![Latest Unstable Version](https://poser.pugx.org/nahidulhasan/eloquent-filter/v/unstable)](https://packagist.org/packages/nahidulhasan/eloquent-filter)
  6 |    [![License](https://poser.pugx.org/nahidulhasan/eloquent-filter/license)](https://packagist.org/packages/nahidulhasan/eloquent-filter)
  7 |   
  8 | 
  9 | 
 10 |   This simple package helps you filter Eloquent data using query filters.  
 11 |   
 12 | ## Installation  
 13 |  
 14 | Run  the following command:  
 15 |  
 16 | ```  
 17 | $ composer require nahidulhasan/eloquent-filter  
 18 | ```  
 19 |   
 20 |   
 21 | ## Getting started  
 22 |   
 23 | Use the trait `NahidulHasan\EloquentFilter\Filterable` in your eloquent model.
 24 | 
 25 | Create a new class by extending the class `NahidulHasan\EloquentFilter\QueryFilters` and define your custom filters as methods with one argument. Where function names are the filter argument name and the arguments are the value.   
 26 |   
 27 | Let's assume you want to allow to filter articles data. Please see the following code.  
 28 |   
 29 | ```php 
 30 | <?php  
 31 | 
 32 | namespace App\Models;
 33 | 
 34 | use Illuminate\Database\Eloquent\Model;  
 35 | use NahidulHasan\EloquentFilter\Filterable;  
 36 |   
 37 | class Article extends Model  
 38 | {  
 39 | 	use Filterable; 
 40 | 	 
 41 | 	/*
 42 | 	* The attributes that are mass assignable. 
 43 | 	*  @var array 
 44 | 	*/ 
 45 | 	protected $fillable = ['title', 'body'];
 46 | }  
 47 |   
 48 | ```  
 49 |   
 50 | Create ArticleFilter class extending QueryFilters.  
 51 |   
 52 | ```php  
 53 | <?php
 54 | 
 55 | namespace App\Filters;  
 56 |   
 57 | use Illuminate\Database\Eloquent\Builder;  
 58 | use NahidulHasan\EloquentFilter\QueryFilters;  
 59 |   
 60 | class ArticleFilters extends QueryFilters  
 61 | {  
 62 |   	/*  
 63 | 	* Filter by Title. 
 64 | 	* @param $title 
 65 | 	* @return Builder 
 66 | 	* @internal param $name 
 67 | 	* @internal param string $level 
 68 | 	*/ 
 69 | 	public function title($title) { 
 70 | 		return $this->builder->where('title', 'like', '%' .$title.'%'); 
 71 | 	}
 72 | }  
 73 | ```  
 74 |   
 75 | With this class we can use the http query string : `title=article_name` or any combination of these filters. It is up to you to define if you will use AND wheres or OR.   
 76 | 
 77 | Now in the controller you can apply these filters like as described in below  :    
 78 |   
 79 |   
 80 | ```php  
 81 | <?php
 82 | 
 83 | namespace App\Http\Controllers;  
 84 |   
 85 | use App\Filters\ArticleFilters;  
 86 | use App\Models\Article;  
 87 | use Illuminate\Http\Request;  
 88 |   
 89 | /**  
 90 | * Class ArticleController 
 91 | * @package App\Http\Controllers 
 92 | */
 93 | class ArticleController extends Controller  
 94 | {  
 95 | 	/* 
 96 | 	* Display a listing of the resource. 
 97 | 	*  @param ArticleFilters $filters 
 98 | 	*  @return \Illuminate\Http\Response 
 99 | 	*  @internal param Request $request 
100 | 	*/ 
101 | 	public function index(ArticleFilters $filters) 
102 | 	{  
103 | 		$articles = Article::filter($filters)->paginate(5);  
104 | 		
105 | 		return view('articles.index', compact('articles'))->with('i', (request()->input('page', 1) - 1) * 5); 
106 | 	}
107 | }    
108 | ```  
109 | 
110 | If you go to this link you will get all code: 
111 | https://github.com/nahidulhasan/laravel-eloquent-query-filtering
112 | 
113 | 
114 | ### Thanks to :  
115 | https://github.com/laracasts/Dedicated-Query-String-Filtering  
116 |   
117 |   
118 | ### License  
119 |   
120 | Eloquent-Filter for Laravel is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
121 | 
122 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "nahidulhasan/eloquent-filter",
 3 |     "description": "Laravel eloquent query filter",
 4 |     "type": "package",
 5 |     "license": "MIT",
 6 |     "authors": [
 7 |         {
 8 |             "name": "Nahidul Hasan",
 9 |             "email": "nahidul.cse@gmail.com"
10 |         }
11 |     ],
12 |     "minimum-stability": "dev",
13 |     "require": {},
14 | 
15 |     "autoload": {
16 |       "psr-4": {
17 |         "NahidulHasan\\EloquentFilter\\": "src/"
18 |       }
19 |     },
20 | 
21 |     "extra": {
22 |       "laravel": {
23 |         "providers": [
24 |           "NahidulHasan\\EloquentFilter\\EloquentFilterServiceProvider"
25 |         ]
26 |       }
27 |     }
28 | }
29 | 


--------------------------------------------------------------------------------
/src/EloquentFilterServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace NahidulHasan\EloquentFilter;
 3 | 
 4 | use Illuminate\Support\ServiceProvider;
 5 | 
 6 | class EloquentFilterServiceProvider extends ServiceProvider
 7 | {
 8 |     /**
 9 |      * Register services.
10 |      *
11 |      * @return void
12 |      */
13 |     public function register()
14 |     {
15 |         //
16 |     }
17 | 
18 |     /**
19 |      * Bootstrap services.
20 |      *
21 |      * @return void
22 |      */
23 |     public function boot()
24 |     {
25 |         //
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Filterable.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace NahidulHasan\EloquentFilter;
 3 | 
 4 | use Illuminate\Database\Eloquent\Builder;
 5 | 
 6 | trait Filterable
 7 | {
 8 |     /**
 9 |      * Filter a result set.
10 |      *
11 |      * @param  Builder      $query
12 |      * @param  QueryFilters $filters
13 |      * @return Builder
14 |      */
15 |     public function scopeFilter($query, QueryFilters $filters)
16 |     {
17 |         return $filters->apply($query);
18 |     }
19 | }


--------------------------------------------------------------------------------
/src/QueryFilters.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace NahidulHasan\EloquentFilter;
 3 | 
 4 | use Illuminate\Database\Eloquent\Builder;
 5 | use Illuminate\Http\Request;
 6 | 
 7 | abstract class QueryFilters
 8 | {
 9 |     /**
10 |      * The request object.
11 |      *
12 |      * @var Request
13 |      */
14 |     protected $request;
15 | 
16 |     /**
17 |      * The builder instance.
18 |      *
19 |      * @var Builder
20 |      */
21 |     protected $builder;
22 | 
23 |     /**
24 |      * Create a new QueryFilters instance.
25 |      *
26 |      * @param Request $request
27 |      */
28 |     public function __construct(Request $request)
29 |     {
30 |         $this->request = $request;
31 |     }
32 | 
33 |     /**
34 |      * Apply the filters to the builder.
35 |      *
36 |      * @param  Builder $builder
37 |      * @return Builder
38 |      */
39 |     public function apply(Builder $builder)
40 |     {
41 |         $this->builder = $builder;
42 | 
43 |         foreach ($this->filters() as $name => $value) {
44 |             if (! method_exists($this, $name)) {
45 |                 continue;
46 |             }
47 | 
48 |             if (strlen($value)) {
49 |                 $this->$name($value);
50 |             } else {
51 |                 $this->$name();
52 |             }
53 |         }
54 | 
55 |         return $this->builder;
56 |     }
57 | 
58 |     /**
59 |      * Get all request filters data.
60 |      *
61 |      * @return array
62 |      */
63 |     public function filters()
64 |     {
65 |         return $this->request->all();
66 |     }
67 | }


--------------------------------------------------------------------------------