Eloquent Filter 使用教程

Eloquent Filter 使用教程

eloquent-filterEloquent Filter is a package for filter data of models by the query strings. Easy to use and fully dynamic.项目地址:https://gitcode.com/gh_mirrors/el/eloquent-filter

项目介绍

Eloquent Filter 是一个强大的 Laravel 包，提供了一种直观的方式来过滤 Eloquent 模型使用查询字符串。它非常适合用于构建响应式 API 和复杂数据集。该包无缝集成到 Laravel 现有的 Eloquent 模型中，添加了强大且动态的过滤功能，且设置简单。

主要特性

• 支持复杂的查询结构
• 易于覆盖条件以进行自定义行为
• 与 Laravel 和 Eloquent 包括查询构建器的和谐集成
• 对过滤执行和定制的完全控制

项目快速启动

安装

首先，通过 Composer 安装 Eloquent Filter：

composer require mehdi-fathi/eloquent-filter

配置

发布配置文件：

php artisan vendor:publish --provider="EloquentFilter\ServiceProvider"

基本使用

在你的模型中使用 Eloquent Filter：

use EloquentFilter\Filterable;

class User extends Model
{
    use Filterable;

    // 定义过滤字段
    private $filterable = [
        'name',
        'email',
        'age',
    ];
}

在控制器中使用：

namespace App\Http\Controllers;

use App\User;

class UsersController extends Controller
{
    public function index()
    {
        return User::filter()->get();
    }
}

应用案例和最佳实践

案例1：基本过滤

假设你有一个用户列表，并且你想根据年龄和性别进行过滤：

// 请求 URI: /users?age_more_than[operator]=>&age[value]=35&gender=male

public function index()
{
    return User::filter()->get();
}

案例2：复杂过滤

如果你想进行更复杂的过滤，例如按创建日期和电子邮件过滤：

// 请求 URI: /users?created_at[operator]==>&created_at[value]=25-09-2019&email=mehdifathi.developer@gmail.com

public function index()
{
    return User::filter()->get();
}

典型生态项目

Eloquent Filter 可以与其他 Laravel 生态系统项目无缝集成，例如：

• Laravel Passport：用于 API 认证和授权。
• Laravel Horizon：用于监控和管理队列。
• Laravel Telescope：用于调试和监控应用程序。

通过这些集成，你可以构建一个强大且高效的 Laravel 应用程序，同时保持代码的整洁和可维护性。

eloquent-filterEloquent Filter is a package for filter data of models by the query strings. Easy to use and fully dynamic.项目地址:https://gitcode.com/gh_mirrors/el/eloquent-filter