README

简介

一个基于 Laravel 的控制器类和特质，可以将过滤、排序、预加载和分页添加到您的资源 URL。

献给乔尔达诺·布鲁诺

此软件包以我的英雄乔尔达诺·布鲁诺的名字命名。一个真正的先知，敢于梦想超越人们认为可能的事情。由于他的思想和拒绝放弃这些思想，他在1600年被活活烧死。我强烈推荐这部由尼尔·德葛拉斯·泰森讲述的关于他生平的简短卡通片：https://vimeo.com/89241669。

功能

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

教程

要开始使用 Bruno，我强烈推荐我的关于 Laravel APIs 中的资源控制 的文章

安装

对于 Laravel 5.3 及以下版本

composer require optimus/bruno ~2.0

对于 Laravel 5.4 及以上版本

composer require optimus/bruno ~3.0

用法

以下示例将针对一个假设的资源端点 /books，它将返回一个属于 Author 的 Book 集合。

Book n ----- 1 Author

可用的查询参数

实现

<?php

namespace App\Http\Controllers;

use Optimus\Api\Controller\EloquentBuilderTrait;
use Optimus\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

将返回一个预加载了 Author 的 5 个 Book 集合。

ID 模式

/books?includes[]=author:ids

将返回一个包含其 Author ID 的 Book 集合。

侧加载模式

/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": "Optimus",
                "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 的属性使用自定义过滤器，则Bruno将尝试从Book模型中延迟加载author关系。

自定义过滤器函数

示例

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

作者名字以Optimus开头或以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(可选)]在评估时构建一个详尽的过滤器数组。

例如，这个过滤器组（详尽）

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

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

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

标准

此包符合PSR-1、PSR-2和PSR-4标准。如果您发现合规性疏忽，请通过pull request发送补丁。

测试

$ phpunit

贡献

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

许可

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