DEV Community: Mehdi Fathi

Simplify Eloquent Query Filtering in Laravel with Eloquent Filter

Mehdi Fathi — Sun, 23 Mar 2025 07:14:19 +0000

Introduction

Filtering data in Laravel applications can become repetitive and messy, especially when dealing with complex queries. If you have ever done an advanced search page or reporting system, you know this fact managing this feature is difficult.

Mention that Eloquent Filter is a package that simplifies this process by providing a clean and reusable way to filter Eloquent models.

The link to the checkout is GitHub Eloquent Filter repository.

What is Eloquent Filter?

Explain what the package does: It allows you to filter Eloquent models based on query parameters. It helps keep your controllers clean by moving filtering logic into dedicated filter classes.

It supports dynamic filtering, making it easy to add or modify filters without changing your codebase extensively.

Highlight its key features:

Easy to install and configure.
Supports complex filtering conditions.
Works seamlessly with Laravel’s Eloquent ORM.
Supports query builder.

Installation

Run the Composer command

$ composer require mehdi-fathi/eloquent-filter

2- Add eloquentFilter\ServiceProvider::class to provider app.php

   'providers' => [
     /*
      * Package Service Providers...
      */
      eloquentFilter\ServiceProvider::class
   ]

In the latest Laravel version add it to providers.php:

    return [
        App\Providers\AppServiceProvider::class,
        eloquentFilter\ServiceProvider::class
    ];

3- Add Facade 'EloquentFilter' => eloquentFilter\Facade\EloquentFilter::class to aliases app.php

'alias' => [
  /*
   * Facade alias...
   */
    'EloquentFilter' => eloquentFilter\Facade\EloquentFilter::class,
],

Basic Usage

Add the Filterable trait to your models and set fields in the whitelist array in which you will want to use of
filter.

You can override this method in your models as well.

use eloquentFilter\QueryFilter\ModelFilters\Filterable;

class User extends Model
{
    use Filterable;

    private static $whiteListFilter =[
        'id',
        'username',
        'email',
        'created_at',
        'updated_at',
    ];
}

You can set * char for that filter in all fields.

A simple implementation with Eloquent Filter

Eloquent Filter can help you to manage these features. Just you will set the query string to work with that.
It would make your own query automatically and systematically while you can control them.

Right after installing Eloquent Filter, the request URI would be like this:

/users/list?age_more_than[operator]=>&age[value]=35&gender=male&created_at[operator]==>&created_at[value]=25-09-2019

And in the Controller, You just need that one line:

/**
 * Class UsersController.
 */

namespace App\Http\Controllers;

use App\User;

class UsersController
{
    public function list()
    {
        return User::filter()->get();
    }
}

Eloquent Filter is supporting query builder

Usage is just extremely like model you need to use filter as a method. Obviously, there's no need for any change.

 DB::table('users')->filter();

Conditions Guidance Table

To better understand this, I provided a table of all conditions and samples. It represents how eloquent filter detect params and each param what query would make.

Condition Name	Eloquent Method	Param	Example	Eloquent	DB
WhereCustomCondition			Declared custom method of Model	✅	❌
SpecialCondition		f_params[limit]=10	support f_params, e.g: limit and order	✅	✅
WhereBetweenCondition	whereBetween	created_at[start]=2016/05/01 &created_at[end]=2017/10/01	whereBetween( 'created_at', [{start},{end}])	✅	✅
WhereByOptCondition	where	count_posts[operator]=>& count_posts[value]=35	where('count_posts', ">", $value)	✅	✅
WhereLikeCondition	where	first_name[like]=John	where('first_name', 'like', $value)	✅	✅
WhereInCondition	whereIn	username[]=David& username[]=John12	whereIn('username', $value)	✅	✅
WhereOrCondition	orWhere	username=Bill& or[username]=James	orWhere('username', $value)	✅	✅
WhereHas	WhereHas	posts[title]=sport one	whereHas('posts', function ($q) {$q->where('title', $value)});	✅	✅
WhereDoesntHaveCondition	whereDoesntHave	doesnt_have=category	doesntHave($value)	✅	✅
WhereDateCondition	whereDate	created_at=2024-09-01	whereDate('created_at', $value)	✅	✅
WhereYearCondition	whereYear	created_at[year]=2024	whereYear('created_at', $value)	✅	✅
WhereMonthCondition	whereMonth	created_at[month]=3	whereMonth('created_at', $value)	✅	✅
WhereDayCondition	whereDay	created_at[day]=15	whereDay('created_at', $value)	✅	✅
WhereNullCondition	whereNull	username[null]=true	whereNull('username')	✅	✅
WhereNotNullCondition	whereNotNull	username[not_null]=true	whereNotNull('username')	✅	✅
WhereCondition	where	username=Mehdi	where('username', $value)	✅	✅

Simple Examples

You just pass data form as query string. For example:

Simple Where

/users/list?email=mehdifathi.developer@gmail.com

SELECT ... WHERE ... email = 'mehdifathi.developer@gmail.com'

/users/list?first_name=mehdi&last_name=fathi

SELECT ... WHERE ... first_name = 'mehdi' AND last_name = 'fathi'

If you send date format Y-m-d we will work like WhereDate() method Laravel.

/users/list?created_at=2024-09-01

SELECT ... WHERE ... strftime('%Y-%m-%d', "created_at") = cast(2024-09-01 as text)

Where In

This example make method whereIn.

/users/list?username[]=ali&username[]=ali22&family=ahmadi

SELECT ... WHERE ... username in ('ali','ali22') AND family = 'ahmadi'

OrWhere

This example make method orWhere().

/users/list?name=mehdi&username=fathi&or[username]=ali

SELECT ... WHERE ... name = 'mehdi' AND username = 'fathi' or username = 'ali'

Where like

If you are going to make a query by like conditions. You can do that by this example.

/users/list?first_name[like]=%John%

SELECT ... WHERE ... first_name LIKE '%John%'

Where by operator

You can set any operator mysql in the queries string.

/users/list?count_posts[operator]=>&count_posts[value]=35

SELECT ... WHERE ... count_posts > 35

/users/list?username[operator]=!=&username[value]=ali

SELECT ... WHERE ... username != 'ali'

/users/list?count_posts[operator]=<&count_posts[value]=25

SELECT ... WHERE ... count_posts < 25

Where the nested relations Model

You can set all nested relations in the query string just via the array of query string. Imagine, the user model has a
relation with posts. And posts table has a relation with orders table.

You can make query conditions by set posts[count_post] and posts[orders][name] in the query string.

Just be careful you must set posts.count_post and posts.orders.name in the User model.

use eloquentFilter\QueryFilter\ModelFilters\Filterable;

class User extends Model
{
    use Filterable;

    private static $whiteListFilter =[
        'username',
        'posts.count_post',
        'posts.category',
        'posts.orders.name',
    ];

    /**
     * @return \Illuminate\Database\Eloquent\Relations\belongsTo
     */
    public function posts()
    {
        return $this->belongsTo('Models\Post');
    }

}

/users/list?posts[count_post]=876&username=mehdi

select * from "users" where exists 
         (select * from "posts" where "posts"."user_id" = "users"."id" 
         and "posts"."count_post" = 876)
         and "username" = "mehdi"

The above example is the same code that you used without the eloquent filter. Check it under code. It's not amazing?

$builder = (new User())->with('posts');
        $builder->whereHas('posts', function ($q) {
            $q->where('count_post', 876);
        })->where('username','mehdi');

Where array the nested relation Model

You can pass array to make whereIn condition.

/users/list?posts[category][]=php&posts[category][]=laravel&posts[category][]=jquery&username=mehdi

select * from "users" where exists 
         (select * from "posts" where 
         "posts"."category" in ('php','laravel','jquery') )
         and "username" = "mehdi"

Doesnthave Where (new feature)

/tags/list?doesnt_have=category

select * from "tags" where not exists (select * from "categories" where "tags"."foo_id" = "categories"."id")'

To fetching those data that doesn't have any relationship with the model as the same Doesnthave method worked.

*Special Params*

You can set special params limit and orderBy in the query string to make a query by that.

/users/list?f_params[limit]=1

SELECT ... WHERE ... order by `id` desc limit 1 offset 0

/users/list?f_params[orderBy][field]=id&f_params[orderBy][type]=ASC

SELECT ... WHERE ... order by `id` asc

/users/list?f_params[orderBy][field]=id,count_posts&f_params[orderBy][type]=ASC

SELECT ... WHERE ...  order by `id` asc, `count_posts` asc

Where between

If you are going to make a query based on date, You must fill keys, start, and end in the query string.
Hence You can set it as a query string. These params are used for the filter by date.

/users/list?created_at[start]=2016/05/01&created_at[end]=2017/10/01

SELECT ... WHERE ... created_at BETWEEN '2016/05/01' AND '2017/10/01'

*Advanced Where*

/users/list?count_posts[operator]=>&count_posts[value]=10&username[]=ali&username[]=mehdi&family=ahmadi&created_at[start]=2016/05/01&created_at[end]=2020/10/01
&f_params[orderBy][field]=id&f_params[orderBy][type]=ASC

select * from `users` where `count_posts` > 10 and `username` in ('ali', 'mehdi') and 
`family` = ahmadi and `created_at` between '2016/05/01' and '2020/10/01' order by 'id' asc limit 10 offset 0

Therefore, fields of query string are same rows table database in $whiteListFilter in your model or declare the method in your model as override method.
The overridden method can be considered a custom query filter.

For more information about the feature's Eloquent Filter, you'd better see the GitHub Eloquent Filter repository.

Reaching an improved realistic testing approach in the Laravel feature test

Mehdi Fathi — Mon, 25 Mar 2024 12:05:50 +0000

It's been some time since I felt a gap in integration testing applications like feature tests in Laravel. At first look, we think running a few isolated tastes without any effects of other actions would be reliable. Let's talk about the pros and cons. I'll bring a way to a real enterprise application that would be enhanced against incoming problems like a chess super grandmaster playing blindfold chess.

Imagine you have a complicated enterprise application with hundreds of feature tests. You should provide a bunch of data with the factory to ensure the tests would be passed. However in reality this might not happen. I mean either the user's behavior or consequently users' data generated by themselves aren't like test processes completely. Therefore users might encounter a few errors that those cases weren't thought of in advance.

Additionally, you can't consider each of the scenarios in detail. You know an enterprise application would have dozens of conditions in every action.Whether we can make a specific test for every one of them?

on the other hand, since some applications don't have feature tests from the beginning, Writing tests for current code is like reading the whole source code to ensure considering everything.

1- Isolated tests are useful for running individually, not continuously

Isolated tests would be a flaw in the case of complex applications. Because end users will send requests to a bunch of endpoints to make their data, they send a request to that endpoint to see their result.

In other words, in production, other's actions would impact your method however you declare a way to pass your test in the feature test Laravel by mocking and factory data. It might lead to false confidence in the code.

In this way, You want to make sure that the code works well without any effect of other methods while real application would impact other actions.

2- Unable to consider all aspects and scenarios

Considering all aspects and scenarios tests in advance or in coding time would be tough. The code might be updated every day then writing tests might be for each change might impossible. Meanwhile, the developer who adds a new change is the best person to refactor or implement the tests.

So generally, other developers don't want to implement tests for other developers' code. Furthermore, how often should we mock other services such as sending emails, notifications, and SMS or third-party endpoints? These days our dependencies have been enhancing these types of services. Therefore mocking them can be deceptive sometimes.

Sicilian Test Orchestra would be more realistic tests

We shouldn't expect feature tests to test all aspects completely although feature tests are really useful However I want to introduce a new way to fill this gap I mentioned.

I've been working on a new package that provides a testing process like the end users' behavior called Sicilian Test OrchestraGithub. It sends a bunch of different requests to every one of the methods continuously without any database truncating then shows in detail and saves all reports in the database.

There's no need to code for every method. You just need to declare routes with its requests and we run randomized to detect what the application reacts. For example :


$ composer require mehdi-fathi/sicilian-test-orchestra

'providers' => [
  /*
   * Package Service Providers...
   */
   SicilianTestOrchestra\SicilianTestOrchestraServiceProvider::class
]


namespace Tests\Feature;

// use Illuminate\Foundation\Testing\RefreshDatabase;
use SicilianTestOrchestra\RequestStrategyTestable;
use Tests\TestCase;

class ExampleTest extends TestCase
{

    use RequestStrategyTestable;

    protected array $testOrchestraRequests = [
      'user_login' => ['auth'],  //auth,quest
      'shuffle_next' => true,
      'next' => [
          [
              'route' => 'save',
              'method' => 'post',
              'data' => [
                  'body' => ['string', 'min:1', 'max:4'],
              ],
              'call' => 1,
              'call_shuffle' => 5,
          ],
          [
              'route' => 'update',
              'method' => 'put',
              'data' => [
                  'body' => ['string', 'min:1', 'max:4'],
              ],
              'param' => [
                  'id' => ['numeric', 'min:1', 'max:1']
              ],
              'call' => 1,
              'call_shuffle' => 2,
          ],
          [
              'route' => 'list',
              'method' => 'get',
              'data' => [],
              'call' => 1,
              'call_shuffle' => 2,
          ],
          [
              'route' => 'show',
              'method' => 'get',
              'data' => [
                  'id' => ['numeric', 'min:1', 'max:1']
              ],
              'call' => 1,
              'call_shuffle' => 2,
          ],
          [
              'route' => 'destroy',
              'method' => 'get',
              'data' => [
                  'id' => ['numeric', 'min:1', 'max:1']
              ],
              'call' => 1,
              'call_shuffle' => 2,
          ],
          [
              'route' => 'show',
              'method' => 'get',
              'data' => [
                  'id' => ['numeric', 'min:1', 'max:1']
              ],
              'call' => 1,
              'call_shuffle' => 2,

          ],
      ]
];

}

Run this command to create migration for the report_tests table:

php artisan vendor:publish --tag=migrations

You declare treat of your methods as above so run your tests :

php artisan test

In the data key, we've taken advantage of Faker lib to generate data. call_shuffle is a key to number call randomly without any order.

You'll see all the results of tests in detail. every time you run tests you can see some new response. In addition, We keep those on a table to check what happened in tests. It should be better to run many times in a task schedule.

About Sicilian Test Orchestra in detail

Since this package is new, I want to foster that gradually. As I mentioned, this package would be used to test Laravel Applications, potentially. This project is released recently in the 1.0 version. What would encourage me to develop is to read your ideas and viewpoints. So Not only I would like to know your thoughts about that gap in the feature test But also your view about the Sicilian Test Orchestra would be helpful. This package has a long way to go. I would like you to comment freely or make an issue in my GitHub.

For more details check out GitHub repository

Introduce Eloquent Filter 2 in Laravel

Mehdi Fathi — Fri, 12 Jun 2020 17:38:29 +0000

Introduction

Have you ever experienced make an advanced search page in programming? if your answer is yes maybe you know this feature has many conditions to make a query database. Especially when you are using a relational DB as MySQL in your project at that time our task will be getting hard. I was searching for it. Eventually, I found a clean way to implement this feature in the Laravel project. I want to introduce the Eloquent Filter to implement this feature in the laravel.

What's the main problem?

The main problem is that you will make many conditions for every situation. Writing a lot of terms will surely reduce the readability of your code and increase the possibility of making a mistake.
Practical example:
Suppose we want to get the list of the users with the requested parameters as follows in the laravel:

http://localhost:8000/users/search?age_more_than=25&gender=male&created_at=25-09-2019

The Request parameter will be as follows:

[ 
  'age_more_than' => '24',
  'gender' => 'male',
  'created_at' => '25-09-2019',
]

Implement this feature in UsersController.php

We check out a condition for each request.

In the future, if your project will need more filter requests at that time you should add many conditions to the above code. Imagine some of the queries may be advanced therefore your code to be like Monster!

Discover away

Everything began from just a tutorial video called Eloquent Techniques in laracast. It was about a new way to make an advanced filter by use of the query string in the Laravel. It has to separate layer filters from controller and model. It made an Eloquent query by the use of a query string. Advanced Eloquent rescued the readability of your code by a filter class. It was very good but you had to make a method for every condition. It's boring for a creative developer. You don't have a dynamic query and you have to write many methods for per condition just in a separate layer.

Eloquent Filter is your solution

Imagine you will install a package composer and make a query by query string without write where for every condition. Actually you just enter query string according to the principles of that package. Therefore the package will make every condition by the query string. If you want to write a custom query in the separated layer you can do it. You can set fields of your model to allow build queries by the query string. Note that the query string must be sync with the fields of your Model. Isn't great in your opinion !?. This package saves your time and your code in laravel project. Fortunately like package eloquent-filter is rare in GitHub.

Installation

1- Run the Composer command

$ composer require mehdi-fathi/eloquent-filter

2- Add eloquentFilter\ServiceProvider::class to provider app.php

'providers' => [
  /*
   * Package Service Providers...
   */
    eloquentFilter\ServiceProvider::class
],

3- Add Facade 'EloquentFilter' => eloquentFilter\Facade\EloquentFilter::class to aliases app.php

'alias' => [
  /*
   * Facade alias...
   */
    'EloquentFilter' => eloquentFilter\Facade\EloquentFilter::class,
],

Just this the Elqouent Filter is ready for use.

Basic Usage

Add Filterable trait to your models and set fields that you will want a filter in the whitelist. You can override this method in your models.

You can set * char for filter in all fields as like below example:

private static $whiteListFilter = ['*'];

Use in Controller

Note that the Eloquent Filter by default using the query string or request data to make queries.
Also, you can set the array to filter method Model for making your own custom condition without query string.
Note that you must unset your own param as perpage. Just you can set page param for paginate this param ignore from filter.

You can ignore some request params by use of code it.

User::ignoreRequest(['perpage'])->filter()
            ->paginate(request()->get('perpage'), ['*'], 'page');

Call ignoreRequest will ignore some requests that you don't want to use in conditions eloquent filter.
For example perpage param will never be in the conditions eloquent filter.
it's related to the paginate method. page param ignore by default in the Eloquent filter.

Another example use of a filter eloquent filter.

User::filter()->paginate();

Done it!

Simple Example

You just pass the data blade form to query string or generate a query string in the controller method. For example:

Simple Where

/users/list?email=mehdifathi.developer@gmail.com
SELECT ... WHERE ... email = 'mehdifathi.developer@gmail.com'

/users/list?first_name=mehdi&last_name=fathi
SELECT ... WHERE ... first_name = 'mehdi' AND last_name = 'fathi'

/users/list?username[]=ali&username[]=ali22&family=ahmadi
SELECT ... WHERE ... username = 'ali' OR username = 'ali22' AND family = 'ahmadi'

Where by operator

You can set any operator MySQL in the query string.

/users/list?count_posts[operator]=>&count_posts[value]=35
SELECT ... WHERE ... count_posts > 35

/users/list?username[operator]=!=&username[value]=ali
SELECT ... WHERE ... username != 'ali'

/users/list?count_posts[operator]=<&count_posts[value]=25
SELECT ... WHERE ... count_posts < 25

Where the nested relation Model (New feature version 2 🔥)

You can set all nested relation in the query string just by the array query string. For example, the user model has a relation with posts. and posts table has a relation with orders. You can make query conditions by set 'posts[count_post]' and 'posts[orders][name]' in the query string. Just be careful you must set 'posts.count_post' and 'posts.orders.name' in the User model.

/users/list?posts[count_post]=876&username=mehdi

select * from "users" where exists 
         (select * from "posts" where 
         "posts"."user_id" = "users"."id" 
         and "posts"."count_post" = 876)
         and "username" = "mehdi"

The above example as the same code that you use without the eloquent filter. Check it under code

$user = new User();
$builder = $user->with('posts');
        $builder->whereHas('posts', function ($q) {
            $q->where('count_post', 876);
        })->where('username','mehdi');

Special Parameters

You can set special parameters limit and orderBy in query string for make query by that.

/users/list?f_params[limit]=1
SELECT ... WHERE ... order by `id` desc limit 1 offset 0

/users/list?f_params[orderBy][field]=id&f_params[orderBy][type]=ASC
SELECT ... WHERE ... order by `id` ASC limit 10 offset 0

Where between

If you are going to make a query whereBetween. You must fill the keys start and end in the query string. you can set it on query string as you know.

/users/list?created_at[start]=2016/05/01&created_at[end]=2017/10/01
SELECT ... WHERE ... created_at BETWEEN '2016/05/01' AND '2017/10/01'

Advanced Where

/users/list?count_posts[operator]=>&count_posts[value]=10&username[]=ali&username[]=mehdi&family=ahmadi&created_at[start]=2016/05/01&created_at[end]=2020/10/01
&f_params[orderBy][field]=id&f_params[orderBy][type]=ASC

select * from `users` where `count_posts` > 10 and `username` in ('ali', 'mehdi') and 
`family` = ahmadi and `created_at` between '2016/05/01' and '2020/10/01' order by 'id' asc limit 10 offset 0

Just note that fields of query string be the same rows table database in $whiteListFilter in your model or declare the method in your model as the override method. The overriding method can be considered custom query filter.

Custom query filter

If you are going to make yourself a query filter you can do it easily. You just make a trait and use it on model:

Note that fields of query string be the same methods of a trait. Use the trait in your model:

/users/list?username_like=a

select * from `users` where `username` like %a% order by `id` desc limit 10 offset 0

You can make every filter with eloquent-filter. If you think the eloquent-filter is useful so give a ⭐️ to that by click in the link
GitHub.

For more details check out GitHub repository

Good luck and thank you for sharing your valuable time with me. I hope the Eloquent Filter is useful for your code. If you have any idea or opinion I glade to know it.

How to be a good developer

Mehdi Fathi — Mon, 04 May 2020 17:37:01 +0000

I want to talk about who is a good developer.I'm trying to say simply to you.

The top advantages of developers are :

-He was never disappointed in the working and life.

-He's done any bugs in the code.

-He's always searching for a new way for old problems.

-Don't be too happy when your problem of code is done.becuase you feel knowing anything in the world of programming and you never try to learn new things.

-Make a challenge for yourself.you can use GitHub to make a new repository and you will develop that.

-less ask questions and more search on google.

Making the advanced query filter with Eloquent Filter in Laravel

Mehdi Fathi — Sun, 22 Dec 2019 16:32:11 +0000

Introduction

Have you ever experienced make an advanced search page in programming? if your answer is yes maybe you know this feature has many conditions to make a query database.Especially when you are using a relational DB as MySQL in your project at that time our task will getting hard. I was searching for it. Eventually, I found a clean way to implement this feature in the Laravel project.

What's the main problem?

The main problem is that you will make many conditions for every situation. Writing a lot of terms will surely reduce the readability of your code and increase the possibility of make a mistake.
Practical example:
Suppose we want to get the list of the users with the requested parameters as follows:

http://localhost:8000/users/search?age_more_than=25&gender=male&created_at=25-09-2019

The Request parameter will be as follows:

[ 
  'age_more_than' => '24',
  'gender' => 'male',
  'created_at' => '25-09-2019',
]

Implement this feature in UsersController.php

We check out a condition for each request.

Discover away

Everything began from just a tutorial video called Eloquent Techniques in laracast. It was about a new way to make an advanced filter by use of the query string. It has to separate layer filters from controller and model. It made an Eloquent query by the use of a query string. Advanced Eloquent rescued the readability of your code by a filter class. It was very good but you had to make a method for every condition. It's boring for a creative developer. You don't have a dynamic query and you have to write many methods for per condition just in a separate layer.

Eloquent Filter is your solution

Imagine you will install a package composer and make a query by query string without write where for every condition. Actually you just enter query string according to the principles of that package. Therefore the package will make every condition by the query string. If you want to write a custom query in the separated layer you can do it. You can set fields of your model to allow build queries by the query string. Note that the query string must be sync with the fields of your Model. Isn't great in your opinion !?. This package saves your time and your code. Fortunately like package eloquent-filter is rare in GitHub.

-NOTE THAT : we've released the Eloquent filter version 2 recently. We suggest to installing version 2 with the new features you can visit this link : https://dev.to/mehdifathi/introduce-eloquent-filter-2-in-laravel-12g5

Installation

Run the Composer command

$ composer require mehdi-fathi/eloquent-filter:1.6.9

Basic Usage

Add Filterable trait to your models and set fields that you will want a filter in whitelist. You can override this method in your models.

You can set * char for filter in all fields as like below example:

private static $whiteListFilter = ['*'];

Use in Controller

Done it!

Simple Example

You just pass the data blade form to query string or generate a query string in the controller method. For example:

Simple Where

/users/list?email=mehdifathi.developer@gmail.com
SELECT ... WHERE ... email = 'mehdifathi.developer@gmail.com'

/users/list?first_name=mehdi&last_name=fathi
SELECT ... WHERE ... first_name = 'mehdi' AND last_name = 'fathi'

/users/list?username[]=ali&username[]=ali22&family=ahmadi
SELECT ... WHERE ... username = 'ali' OR username = 'ali22' AND family = 'ahmadi'

Where by operator

You can set any operator MySQL in the query string.

/users/list?count_posts[operator]=>&count_posts[value]=35
SELECT ... WHERE ... count_posts > 35

/users/list?username[operator]=!=&username[value]=ali
SELECT ... WHERE ... username != 'ali'

/users/list?count_posts[operator]=<&count_posts[value]=25
SELECT ... WHERE ... count_posts < 25

Special Parameters

You can set special parameters limit and orderBy in query string for make query by that.

/users/list?f_params[limit]=1
SELECT ... WHERE ... order by `id` desc limit 1 offset 0

/users/list?f_params[orderBy][field]=id&f_params[orderBy][type]=ASC
SELECT ... WHERE ... order by `id` ASC limit 10 offset 0

Where between

If you are going to make a query whereBetween. You must fill the keys start and end in the query string. you can set it on query string as you know.

/users/list?created_at[start]=2016/05/01&created_at[end]=2017/10/01
SELECT ... WHERE ... created_at BETWEEN '2016/05/01' AND '2017/10/01'

Advanced Where

/users/list?count_posts[operator]=>&count_posts[value]=10&username[]=ali&username[]=mehdi&family=ahmadi&created_at[start]=2016/05/01&created_at[end]=2020/10/01
&f_params[orderBy][field]=id&f_params[orderBy][type]=ASC

select * from `users` where `count_posts` > 10 and `username` in ('ali', 'mehdi') and 
`family` = ahmadi and `created_at` between '2016/05/01' and '2020/10/01' order by 'id' asc limit 10 offset 0

Custom query filter

If you are going to make yourself a query filter you can do it easily. You just make a trait and use it on model:

Note that fields of query string be the same methods of a trait. Use the trait in your model:

/users/list?username_like=a

select * from `users` where `username` like %a% order by `id` desc limit 10 offset 0

You can make every filter with eloquent-filter. If you think the eloquent-filter is useful so give a ⭐️ to that by click in the link
GitHub.

For more details check out GitHub repository

Good luck and thank you for sharing your valuable time with me. I hope the Eloquent Filter is useful for your code. If you have any idea or opinion I glade to know it.