eloquent filter
3.0.0
Полезная библиотека для создания фильтров для Eloquent.
Эта библиотека полезна для создания фильтров поиска в вашем Rest API с помощью Eloquent.
??
Библиотеку 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¬_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 ();Эта библиотека внутренне применяет фильтры на основе параметров строки запроса со специальными именами клавиш.
См. все параметры ниже:
Максимальное значение столбца. 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%') .
Найдите значение в соответствии с конечным содержимым строки. Аналогично LIKE со значением %$value .
Фильтруйте поле, если значение начинается с определенного значения. 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')
Выполняет поиск, когда столбец НЕ ИМЕЕТ переданных значений.
Пример:
URL-адрес api/users?not_in[role][]=1¬_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¬_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 , вы можете использовать параметры 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
}
} )
