iamohd-zz/laravel-query-filter

Filter Eloquent via query URL

Filter Eloquent results via query URL

Laravel query filter is a simple package that allows you to filter Eloquent results via URL query params.

Installation

You can install the package via composer:

composer require smartisan/laravel-query-filter

You can publish the config file with:

php artisan vendor:publish --provider="Smartisan\QueryFilter\QueryFilterServiceProvider" --tag="config"

Usage

1. Create a new filter class using the following command

php artisan make:filter UserFilter

2. Prepare your model with filter trait

use Smartisan\QueryFilter\HasFilters;

class User extends Model
{
    use HasFilters;
}

3. Add a new filter method with your logic to the generated filter class

namespace App\Filters;

use Smartisan\QueryFilter\QueryFilter;

class UserFilter extends QueryFilter
{
    public function status($value)
    {
        return $this->builder->where('status', $value);
    }
}

4. To trigger the filter method, do the following in your controller

public function index(UserFilter $filter)
{
    User::filter($filter)->get();
}

or you can pass the filter class name as string as following:

public function index()
{
    User::filter(UserFilter::class)->get();
}

the status filter method will be triggered automatically when the URL contains the following query param ?status=value

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Mohammed Isa
• All Contributors

License

The MIT License (MIT). Please see License File for more information.