This package allows you to easily handle database filtering through query strings. The idea is taken from one of the Jeffrey's videos (behind the paywall). One quick example might look like this: /users?filter-username=~joe
will result in SQL query select * from users where "username" like '%joe%'
.
You can install the package via composer:
composer require kyslik/laravel-filterable
Laravel will discover the package by itself. If you feel old-school, disable auto-discovery and add Kyslik\LaravelFilterable\FilterableServiceProvider::class
to the providers array in your config/app.php
.
Package lets us create & apply two kinds of filters: custom and generic.
Custom filters are just like in Jeffrey's video. We define our logic on builder instance and package will apply it via local scope.
Let's say we want to display recently created records. We create method recent($minutes = null)
inside our filter class, this method returns Builder instance:
public function recent($minutes = null)
{
$minutes = (is_numeric($minutes)) ? $minutes : 30;
return $this->builder->where('created_at', '>=', Carbon\Carbon::now()->subMinutes($minutes));
}
Full example is shown later on.
Generic filters are those defined in config file. By default, the package supports filtering timestamps
, ranges
, ins
, booleans
and strings
.
/?filter-created_at=t>=1510952444
/?filter-id=><1,19
/?filter-id=i=1,5,10,12
/?filter-admin=b=yes
/?filter-username=joe
/?filter-username=~joe
/?filter-username=~joe&filter-admin=b=yes&filter-created_at=t=1510952444
operator | accepts | description |
---|---|---|
= |
string |
equal |
!= |
string |
not equal |
> |
string |
greater than |
< |
string |
less than |
>= |
string |
equal or greater than |
<= |
string |
equal or less than |
~ |
string |
like |
!~ |
string |
not like |
>< |
comma separated list | between |
!>< |
comma separated list | not between |
i= |
comma separated list | in |
i!= |
comma separated list | not in |
b= |
1 , 0 , true , false , yes , no |
equal |
b!= |
1 , 0 , true , false , yes , no |
not equal |
t= |
UNIX timestamp | equal |
t!= |
UNIX timestamp | not equal |
t> |
UNIX timestamp | greater than |
t< |
UNIX timestamp | less than |
t>= |
UNIX timestamp | equal or greater than |
t<= |
UNIX timestamp | equal or less than |
t>< |
UNIX timestamp | between |
t!>< |
UNIX timestamp | not between |
While using both custom or generic filters we must:
- have local scope on model with signature
scopeFilter(Builder $query, FILTERNAME $filters)
- have particular (
FILTERNAME
) filter class that extends one of:Kyslik\LaravelFilterable\GenericFilterable
class - enables us to use both custom & generic filtersKyslik\LaravelFilterable\Filterable
class - enables us to use only custom filters
- call scope within a controller
Let's say we want to use filterable on user model. We will have to create filter class App/Filters/UserFilter.php
, specify filterMap()
and method with our custom logic.
<?php
namespace App\Filters;
use Kyslik\LaravelFilterable\Filterable;
class UserFilters extends Filterable
{
public function filterMap()
{
return ['recent' => ['recently', 'recent']];
}
public function recent($minutes = null)
{
$minutes = (is_numeric($minutes)) ? $minutes : 30;
return $this->builder->where('created_at', '>=', \Carbon\Carbon::now()->subMinutes($minutes)->toDateTimeString());
}
}
Note:
filterMap()
must be defined and it should return associative array where key is method name and value is either alias or array of aliases
Secondly, we will have to add a local scope to our user model via trait:
use Kyslik\LaravelFilterable\FilterableTrait;
...
class User extends Model
{
use FilterableTrait;
...
}
Finally, in user controller we will have to call model's scope:
public function index(User $user, UserFilters $filters)
{
return $user->filter($filters)->paginate();
}
Now we can visit users?recent
or users?recently
or users?recent=25
and results will be filtered by recent()
method defined in UserFilters
class.
Let's say we want to use filterable on user model. We will have to create filter class App/Filters/UserFilter.php
and specify $filterables
.
<?php
namespace App\Filters;
use Kyslik\LaravelFilterable\GenericFilterable;
class UserFilters extends GenericFilterable
{
protected $filterables = ['id', 'username', 'email', 'created_at', 'updated_at'];
}
Secondly, we will have to add a local scope to our user model via trait:
use Kyslik\LaravelFilterable\FilterableTrait;
...
class User extends Model
{
use FilterableTrait;
...
}
Finally, in our user controller we will have to call model's scope:
public function index(User $user, UserFilters $filters)
{
return $user->filter($filters)->paginate();
}
We are ready to filter user model.
Note: behind the scenes
GenericFilterable
class extendsFilterable
class, thus using GenericFilterable also enables us to apply custom filters defined within the filter class
While using generic filters we may define which generics should be allowed. In our filter class we define settings()
method in which we specify settings.
...
class UserFilters extends GenericFilterable
{
protected $filterables = ['id', 'username', 'email', 'created_at', 'updated_at'];
protected function settings()
{
// global settings for this filter, pick either "except" or "only" logic
$this->only(['=', '~', '!~']);
// $this->except(['!=']);
// settings applied only to some columns, these settings ignore settings above
$this->for(['username', 'id'])->only(['!=', '>=', '=', '~']);
$this->for(['id'])->only(['=', '!=', '~']); //settings for "id" will be re-written
}
}
composer test
Please see CHANGELOG for more information what has changed recently.
Please see CONTRIBUTING for details.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.