README

This package provides a nice and easy way to add query filters to your Eloquent models without turning your model classes into massive God objects.

After setting it up, if you are building an API, for example, you can simply add this piece of code to your controller:

User::filter($request->get('filter'))->get();

Now make a request to /api/users?filter[name]=John and let the fun begin.

Installation

Install the package via composer:

composer require gurgentil/eloquent-filters

Usage

Create a filter builder that extends Gurgentil\EloquentFilters\FilterBuilder. This is where you will register all the filters for your Eloquent model.

namespace App\Filters;

use Gurgentil\EloquentFilters\FilterBuilder;

class UserFilters extends FilterBuilder
{
    protected $availableFilters = [];
}

Add the Gurgentil\EloquentFilters\Filterable trait to your model class. The trait will look for a filter builder for the model inside App\Filters.

Creating filters

Run the artisan command:

php artisan make:filter Users/NameFilter

Register the filter in the builder you created previously:

namespace App\Filters;

use App\Filters\Users\NameFilter;
use Gurgentil\EloquentFilters\FilterBuilder;

class UserFilters extends FilterBuilder
{
    protected $availableFilters = [
        'name' => NameFilter::class,
    ];
}

Last but not least, implement your query in NameFilter:

namespace App\Filters\Users;

use Gurgentil\EloquentFilters\Filter;
use Illuminate\Database\Eloquent\Builder;

class NameFilter implements Filter
{
    /**
     * Apply filter.
     *
     * @return Builder
     */
    public function apply(Builder $builder, $value)
    {
        return $builder->where('name', $value);
    }
}

You can perform filter queries on your model by passing a list of filters to the filter method:

User::filter([
    'name' => 'John',
])->get();

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Credits

• Gustavo Rorato Gentil
• All Contributors

License

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