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
    }
} )