eloquent filter

Laravel Legends 雄辩过滤器

一个有用的库，用于为 Eloquent 制作过滤器。

该库对于使用 Eloquent 在 Rest API 中创建搜索过滤器非常有用。

??

描述

Eloquent Filter 库可用于为 Laravel 项目中模型的搜索条件创建模式。这个想法是聚合过滤器只是传递请求负载中的值。

安装

安装时，您应该使用 Composer。运行以下命令：

composer require laravellegends/eloquent-filter

使用指南

LaravelLegendsEloquentFilterConcernsHasFilter特征可以在将应用搜索过滤器的模型中使用。

 use LaravelLegends  EloquentFilter  Concerns  HasFilter ;

class User extends Model
{
    use HasFilter ;
}

HasFilter特征提供了filter和withFilter方法。

在 Laravel 应用程序中使用此库的一个简单方法是在获取模型结果之前调用filter方法。

例子：

 class UsersController extends Controller 
{
    use App  Models  User ;
    
    public function index ()
    {
        return User :: filter ()-> paginate ();
    }

    // or

    public function index ()
    {
        return User :: latest ( ' id ' )-> filter ()-> paginate ();
    }

    // or

    public function index ( Request $ request )
    {
        return User :: filter ( $ request )-> paginate ();
    }
}

您可以在调用/api/users?exact[id]=1时显示结果。将应用 SQL 查询"select * from users where (id = 1)" 。

注意：显示规则会话以获取更多信息。

另一种方法是对模型使用特定的过滤器。您可以继承 ModelFilter 类来为模型创建自定义过滤器。

要创建此类，您应该使用命令php artisan make:filter ，如下例所示：

$ php artisan make:filter UserFilter

上面的命令将生成以下类：

 namespace App  Filters ;

use LaravelLegends  EloquentFilter  Filters  ModelFilter ;

class UserFilter extends ModelFilter 
{
    public function getFilterables (): array
    {
        return [
            ' role_id ' => ' not_equal ' , // or ['not_equal']
            ' name '    => [ ' contains ' , ' starts_with ' ],
        ];
    }
}

在控制器中

 use App  Models  User ;
use Illuminate  Http  Request ;
use LaravelLegends  EloquentFilter  Filter ;

class UsersController extends Controller
{
    // api/users?starts_with[name]=Wallace&not_equal[role_id]=2

    public function index ( Request $ request )
    {
        return User :: withFilter ( new UserFilter , $ request )
                    -> orderBy ( ' name ' )
                    -> get ();
    }
}

上述代码在内部将被调用，示例如下：

 User :: where ( function ( $ query ) {
    $ query -> where ( ' name ' , ' LIKE ' , ' Wallace% ' );
    $ query -> where ( ' role_id ' , ' <> ' , ' 2 ' );
})
-> orderBy ( ' name ' )
-> get ();

---

它有什么作用？

该库在内部应用基于具有特殊 keyworks 名称的查询字符串参数的过滤器。

查看所有参数如下：

最大限度

列的最大值。 url api/users?max[field]=100就像User::where('field', '<=', 100) 。

---

分钟

列的最小值。 url api/users?min[age]=33就像User::where('age', '>=', 33) 。

---

包含

列中包含的搜索词。 url api/users?contains[name]=wallace就像User::where('name', 'LIKE', '%wallace%') 。

---

结束于

根据字符串的结尾内容搜索一个值。类似于具有%$value值的LIKE 。

---

开始于

当值以特定值开头时过滤字段。 url api/users?starts_with[name]=brcontainer听起来像User::where('name', 'LIKE', 'brcontainer%') 。

---

精确的

按字段的精确值搜索· url api/users?exact[email][email protected]听起来像User::where('name', '=', '[email protected]') 。

---

有

按关系过滤。您可以使用0或1值。

例子：

url api/users?has[posts]=1就像User::has('posts')

url api/users?has[posts]=0就像User::doesntHave('posts')

---

为空

将WHERE IS NULL或WHERE IS NOT NULL应用于查询。

例子：

url api/users?is_null[cpf]=1就像User::whereNull('cpf')

url api/users?is_null[age]=0就像User::whereNotNull('age')

---

不在

当列没有传递的值时进行搜索。

例子：

A url api/users?not_in[role][]=1&not_in[role][]=2相当于User::whereNotIn('role', [1, 2])

注意：当not_in[my_field]为空数组时，不会执行任何操作。

---

在

搜索列何时具有传递的值。

例子：

url api/users?in[role][]=10&in[role][]=20听起来像User::whereIn('role', [10, 20])

注意：当in[my_field]为空数组时，不会执行任何操作。

---

最大日期

按日期字段的最大值搜索。

url api/users?date_max[created_at]=2021-01-01听起来像User::whereDate('created_at', '<=', '2021-01-01')

---

最小日期

按日期字段的最小值搜索。

例子：

url api/users?date_min[created_at]=2021-01-01听起来像User::whereDate('created_at', '>=', '2021-01-01')

---

不等于

按传递的不相等值进行搜索。如果您在相关字段中使用，则将应用 whereDoesntHave。

例子：

url api/users?not_equal[profile_id]=3听起来像

 User :: where ( ' profile_id ' , ' <> ' , ' 3 ' );

url api/users?not_equal[roles.id]=1听起来像

 User :: whereDoesntHave ( ' roles ' , fn ( $ query ) => $ query -> where ( ' id ' , ' = ' , 3 ));

---

最大年份

url api/users?year_max[created_at]=2000听起来像

 User :: whereYear ( ' created_at ' , ' <= ' , 2000 );

---

年_分钟

url api/users?year_min[created_at]=1998听起来像

 User :: whereYear ( ' created_at ' , ' >= ' , 1998 );

---

精确年份

url api/users?year_exact[created_at]=1998听起来像

 User :: whereYear ( ' created_at ' , ' = ' , 1998 );

---

过滤关系字段

您可以在模型中定义的关系方法中应用搜索过滤器。

例如：

模型：

 class User extends Model
{
    use HasFilter ;

    public function phones ()
    {
        return $ this -> hasMany ( Phone ::class, ' user_id ' );
    }
}

过滤器：

 class UserFilter extends ModelFilter
{
    public function getFilterables (): array
    {
        return [
            ' id '            => [ ' exact ' , ' not_equal ' ],
            ' created_at '    => [ ' year_exact ' , ' date_max ' , ' date_min ' ],
            ' phones.number ' => [ ' contains ' ],
            // or
            ' phones '        => new PhoneFilter ,
        ];
    }
}

class PhoneFilter extends ModelFilter
{

    public function getFilterables (): array
    {
        return [
            ' number ' => ' contains '
        ];
    }
}

 class UserController extends Controller
{
    public function index ()
    {
        // api/users?not_in[role_id][]=1&not_in[role_id][]=3
        
        // select * from users where (role_id NOT IN (1, 3))

        return User :: withFilter ( new UserFilter )-> paginate ();
    }

    // Or, apply filter as nested query

    public function index () 
    {

        // api/users?exact[role_id]=1
        
        // select * from users where (role_id = 1)

        return User :: where ( UserFilter :: toClosure ())-> paginate ();
    }

    // Or apply in your query as base condition

    public function index ()
    {
        
        // api/users?exact[role_id]=1
        
        // select * from users where role_id = 1

        return User :: tap ( UserFilter :: toClosure ())-> paginate ();
    }
}

在以下示例中，将过滤用户以查找包含值55的相关电话。

api/users?exact[phones.number]=55类似于：

 User :: where ( function ( $ query ) {
    $ query -> whereHas ( ' phones ' , function ( $ query ) {
        $ query -> where ( ' number ' , ' = ' , ' 55 ' );
    });
})-> paginate ();

axios 示例

如果您使用axios库，则可以使用params选项包含上述过滤器。

例子：

 const api = axios . create ( {
    baseURL : 'http://localhost:8000/api'
} ) ;

api . get ( 'users' , {
    params : { 
        'in[role]' : [ 1 , 2 , 3 ] ,
        'contains[name]' : 'Maxters' ,
        'is_null[name]' : 0
    }
} )