Laravel query filter is a simple package that allows you to filter Eloquent results via URL query params.
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"
- Create a new filter class using the following command
php artisan make:filter UserFilter
- Prepare your model with filter trait
use Smartisan\QueryFilter\HasFilters;
class User extends Model
{
use HasFilters;
}
- 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);
}
}
- 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
composer test
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.