README

简介

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

献给乔尔达诺·布鲁诺

这个包以我的英雄乔尔达诺·布鲁诺命名。一个真正的Visionary，敢于梦想超越被认为可能的事情。由于他的思想和拒绝放弃，他在1600年被烧死。我强烈推荐这部关于他生平的短片，由Neil deGrasse Tyson讲述（点击观看）。

功能

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

教程

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

安装

对于 Laravel 6.0 及以上版本

composer require moova/optimus-bruno dev-master

用法

以下示例将使用一个假设的资源端点 /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

将返回一个包含 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标准。如果您发现遵守上的疏忽，请通过拉取请求发送补丁。

测试

$ phpunit

贡献

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

许可

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