README

简介

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

献给乔尔达诺·布鲁诺

此软件包以我的英雄乔尔达诺·布鲁诺命名。一个真正的Visionary，敢于梦想超出人们认为可能的事情。由于他的思想和拒绝放弃它们，他在1600年被活活烧死。 我强烈推荐这部由Neil deGrasse Tyson讲述的关于他生平的短动画片。

功能

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

教程

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

安装

composer require binarygeotech/bruno ~1.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, $in)
{
    if ($in) {
        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年之间出版的书籍。

标准

此软件包符合PSR-1、PSR-2和PSR-4。如果您发现任何不符合标准的地方，请通过pull request发送补丁。

测试

$ phpunit

贡献

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

许可证

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