smartisan/laravel-query-filter

通过查询URL过滤Eloquent

2.0.0 2023-02-16 16:27 UTC

This package is auto-updated.

Last update: 2024-09-16 19:44:24 UTC


README

Latest Version on Packagist GitHub Tests Action Status Total Downloads

Laravel查询过滤器是一个简单的包,允许您通过URL查询参数过滤Eloquent结果。

安装

您可以通过Composer安装此包

composer require smartisan/laravel-query-filter

您可以使用以下命令发布配置文件

php artisan vendor:publish --provider="Smartisan\QueryFilter\QueryFilterServiceProvider" --tag="config"

用法

  1. 使用以下命令创建一个新的过滤器类
php artisan make:filter UserFilter
  1. 将包含您逻辑的新过滤器方法添加到生成的过滤器类中
namespace App\Filters;

use Smartisan\QueryFilter\QueryFilter;

class UserFilter extends QueryFilter
{
    public function status($value)
    {
        return $this->builder->where('status', $value);
    }
}
  1. 要在控制器中触发过滤器方法,请执行以下操作
use App\Filters\UserFilter;

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

当URL包含以下查询参数时,将自动触发状态过滤器方法 ?status=value

测试

composer test

变更日志

请参阅 CHANGELOG 了解最近更改的详细信息。

贡献

请参阅 CONTRIBUTING 了解详情。

安全漏洞

请查阅 我们的安全策略 了解如何报告安全漏洞。

致谢

许可证

MIT许可证(MIT)。请参阅 许可证文件 了解更多信息。