README

本包允许您根据请求进行过滤、排序和包含Eloquent关系。本包中使用的QueryBuilder扩展了Laravel默认的Eloquent构建器。这意味着您仍然可以使用所有您喜欢的函数和宏。查询参数名称尽可能地遵循JSON API规范。

基本用法

根据请求过滤查询：/users?filter[name]=John

use Spatie\QueryBuilder\QueryBuilder;

$users = QueryBuilder::for(User::class)
    ->allowedFilters('name')
    ->get();

// all `User`s that contain the string "John" in their name

了解更多关于过滤功能，如：部分过滤、精确过滤、范围过滤、自定义过滤、忽略值、默认过滤值等。

根据请求包含关系：/users?include=posts

$users = QueryBuilder::for(User::class)
    ->allowedIncludes('posts')
    ->get();

// all `User`s with their `posts` loaded

了解更多关于包含功能，如：包含嵌套关系、包含关系计数、自定义包含等。

根据请求排序查询：/users?sort=id

$users = QueryBuilder::for(User::class)
    ->allowedSorts('id')
    ->get();

// all `User`s sorted by ascending id

了解更多关于排序功能，如：自定义排序、排序方向等。

与现有查询良好协作

$query = User::where('active', true);

$userQuery = QueryBuilder::for($query) // start from an existing Builder instance
    ->withTrashed() // use your existing scopes
    ->allowedIncludes('posts', 'permissions')
    ->where('score', '>', 42); // chain on any of Laravel's query builder methods

选择查询的字段：/users?fields[users]=id,email

$users = QueryBuilder::for(User::class)
    ->allowedFields(['id', 'email'])
    ->get();

// the fetched `User`s will only have their id & email set

了解更多关于选择字段的信息。

支持我们

我们在创建一流的开源软件包上投入了大量资源。您可以通过购买我们的付费产品之一来支持我们。

我们非常感谢您从家乡寄给我们明信片，说明您正在使用我们的哪个包。您可以在我们的联系页面找到我们的地址。我们将发布收到的所有明信片在我们的虚拟明信片墙上。

安装

您可以通过composer安装此包

composer require spatie/laravel-query-builder

在文档网站上阅读安装说明：https://spatie.be/docs/laravel-query-builder/v5/installation-setup。

文档

您可以在https://spatie.be/docs/laravel-query-builder/v5找到文档。

如果您在使用包时遇到困难，发现了错误，或者对媒体库有任何一般性问题或改进建议，请随时在GitHub上创建问题，我们会尽快解决。

如果您发现与安全相关的错误，请通过security@spatie.be发送邮件，而不是使用问题跟踪器。

升级

请参阅UPGRADING.md以获取详细信息。

测试

composer test

变更日志

请参阅CHANGELOG以获取有关最近更改的更多信息。

贡献

请参阅CONTRIBUTING以获取详细信息。

安全

如果您发现与安全相关的错误，请通过security@spatie.be发送邮件，而不是使用问题跟踪器。

致谢

• Alex Vanderbist
• 所有贡献者

许可证

MIT许可证（MIT）。请参阅许可证文件以获取更多信息。