README

介绍

一个Laravel基础控制器类和一个特质，可以帮助你为资源URL添加过滤、排序、预加载和分页。

功能

• 解析GET参数以动态预加载相关资源、排序和分页
• 使用过滤器组进行高级资源过滤
• 使用 Bulwark\Architect 进行侧加载、ID加载或嵌入式加载相关资源
• ... 欢迎提出新功能建议

Laravel 5.4及以上版本

composer require bulwark/dream ~1.0

用法

以下示例将以假设的资源端点 /books 为例，该端点将返回一个包含 Book 对象的集合，每个对象都属于一个 Author。

Book n ----- 1 Author

可用的查询参数

实现

<?php

namespace App\Http\Controllers;

use Bulwark\Api\Controller\EloquentBuilderTrait;
use Bulwark\Api\Controller\LaravelController;
use App\Models\Book;

class BookController extends LaravelController
{
    use EloquentBuilderTrait;

    public function getBooks()
    {
        // Parse the resource options given by GET parameters
        $resourceOptions = $this->parseResourceOptions();

        // Start a new query for books using Eloquent query builder
        // (This would normally live somewhere else, e.g. in a Repository)
        $query = Book::query();
        $this->applyResourceOptions($query, $resourceOptions);
        $books = $query->get();

        // Parse the data using Optimus\Architect
        $parsedData = $this->parseData($books, $resourceOptions, 'books');

        // Create JSON response of parsed data
        return $this->response($parsedData);
    }
}

语法文档

预加载

简单预加载

/books?includes[]=author

将返回一个包含5个 Book 的集合，这些 Book 已经通过 Author 预加载。

IDs模式

/books?includes[]=author:ids

将返回一个包含 Book 的集合，这些 Book 通过其 Author 的ID预加载。

侧加载模式

/books?includes[]=author:sideload

将返回一个包含 Book 的集合以及一个在根作用域中预加载的包含其 Author 的集合。

有关预加载类型的更多信息，请参阅Optimus\Architect的README。

分页

有两个参数可用： limit 和 page。 limit 将确定每页的记录数，而 page 将确定当前页。

/books?limit=10&page=3

将返回第30-40本书。

排序

应定义为排序规则的数组。它们将按照定义的顺序应用。

排序规则

示例

[
    {
        "key": "title",
        "direction": "ASC"
    }, {
        "key": "year",
        "direction": "DESC"
    }
]

将导致书籍按标题升序排序，然后按年份降序排序。

过滤

应定义为过滤器组的数组。

过滤器组

过滤器

运算符

特殊值

自定义过滤器

记住我们的关系 Books n ----- 1 Author。想象一下你想通过 Author 名称过滤书籍。

[
    {
        "filters": [
            {
                "key": "author",
                "value": "Bulwark",
                "operator": "sw"
            }
        ]
    }
]

现在这一切都很不错，但是我们的模型上没有 author 属性，因为这是一个关系。这将导致错误，因为Eloquent会尝试在不存在 author 属性上使用where子句。我们可以通过实现一个自定义过滤器来修复这个问题。在您使用 EloquentBuilderTrait 的任何地方，实现一个名为 filterAuthor 的函数

public function filterAuthor(Builder $query, $method, $clauseOperator, $value)
{
    // if clauseOperator is idential to false,
    //     we are using a specific SQL method in its place (e.g. `in`, `between`)
    if ($clauseOperator === false) {
        call_user_func([$query, $method], 'authors.name', $value);
    } else {
        call_user_func([$query, $method], 'authors.name', $clauseOperator, $value);
    }
}

注意：请注意，自定义过滤器将查找与属性同名的关系。例如，如果尝试为名为 author 的属性使用自定义过滤器，那么 Dream 将尝试从 Book 模型中预加载 author 关系。

自定义过滤器函数

示例

[
    {
        "or": true,
        "filters": [
            {
                "key": "author",
                "value": "Bulwark",
                "operator": "sw"
            },
            {
                "key": "author",
                "value": "Prime",
                "operator": "ew"
            }
        ]
    }
]

作者名称以 Bulwark 或以 Prime 结尾的书籍。

[
    {
        "filters": [
            {
                "key": "author",
                "value": "Brian",
                "operator": "sw"
            }
        ]
    },
    {
        "filters": [
            {
                "key": "year",
                "value": 1990,
                "operator": "gt"
            },
            {
                "key": "year",
                "value": 2000,
                "operator": "lt"
            }
        ]
    }
]

作者名称以 Brian 开头，并且是在1990年至2000年间出版的书籍。

可选的简写过滤语法（简写）

过滤器可以可选地用简写表示，它将根据给定的过滤器数组[key, operator, value, not(optional)]构建一个详细的过滤器数组。

例如，以下过滤器组（详细）

[
    {
        "or": false,
        "filters": [
            {
                "key": "author",
                "value": "Bulwark",
                "operator": "sw"
            },
            {
                "key": "author",
                "value": "Prime",
                "operator": "ew"
            }
            {
                "key": "deleted_at",
                "value": null,
                "operator": "eq",
                "not": true
            }
        ]
    }
]

可以以这种方式表示（简写）

[
    {
        "or": false,
        "filters": [
            ["author", "sw", "Bulwark"],
            ["author", "ew", "Prime"],
            ["deleted_at", "eq", null, true]
        ]
    }
]

标准

本软件包符合PSR-1、PSR-2和PSR-4规范。如果您发现任何不符合规范的地方，请通过Pull Request提交补丁。

测试

$ phpunit

贡献

有关详细信息，请参阅CONTRIBUTING。

许可证

MIT许可证（MIT）。有关更多信息，请参阅许可证文件。