README

简介

一个 Laravel 基础控制器类和一个特性，可以使您向资源 URL 添加过滤、排序、预加载和分页。

献给乔尔达诺·布鲁诺

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

功能

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

教程

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

安装

对于 Laravel 5.3 及以下版本

composer require optimus/bruno ~2.0

对于 Laravel 5.4 及以上版本

composer require optimus/bruno ~3.0

使用

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

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

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

IDs 模式

/books?includes[]=author:ids

将返回一个包含 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": "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(optional)]转换为在评估后的详细过滤数组。

例如，这组过滤器（详细）

[
    {
        "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

贡献

请参阅贡献指南以获取详细信息。

许可证

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