Pagination

基本用法
在视图中显示结果
将结果转换为 JSON

基本用法

有几种方法可以对记录进行分页，最常见的是调用paginate 查询或模型上的方法。这将返回一个特殊的分页集合，它添加了用于显示结果的额外方法。

分页查询生成器结果

有几种方法可以对项目进行分页。最简单的是使用paginate 上的方法查询生成器或模型查询.这paginate 方法会根据用户正在查看的当前页面自动负责设置适当的限制和偏移量。默认情况下，当前页面由?page HTTP 请求的查询字符串参数。当然，这个值会被自动检测并自动插入到分页器生成的链接中。

首先，让我们看一下调用paginate 查询方法。在此示例中，传递给的唯一参数paginate 是您希望“每页”显示的项目数。在这种情况下，让我们指定我们想要显示15 每页项目：

$users = Db::table('users')->paginate(15);

NOTE: 目前，使用groupBy 语句无法有效执行。如果您需要使用groupBy 对于分页结果集，建议您查询数据库并手动创建分页器。

简单分页

如果您只需要在分页视图中显示简单的“下一个”和“上一个”链接，您可以选择使用simplePaginate 方法来执行更有效的查询。如果在呈现视图时不需要为每个页码显示链接，这对于大型数据集非常有用：

$users = Db::table('users')->simplePaginate(15);

分页模型结果

你也可以分页数据库模型查询。在这个例子中，我们将分页User 模型与15 每页项目。如您所见，语法几乎与分页查询生成器结果相同：

$users = User::paginate(15);

当然，你也可以打电话paginate 在对查询设置其他约束后，例如where 条款：

$users = User::where('votes', '>', 100)->paginate(15);

您也可以使用simplePaginate 分页模型时的方法：

$users = User::where('votes', '>', 100)->simplePaginate(15);

您可以通过传递第二个参数手动指定页码，这里我们分页15 每页的项目，指定我们在页面上2:

$users = User::where('votes', '>', 100)->paginate(15, 2);

手动创建分页器

有时您可能希望手动创建一个分页实例，将一个项目数组传递给它。您可以通过创建一个Illuminate\Pagination\Paginator 或者Illuminate\Pagination\LengthAwarePaginator 例如，取决于您的需要。

这Paginator 类不需要知道结果集中的项目总数，因此类没有检索最后一页索引的方法。这LengthAwarePaginator 接受与Paginator，但是它确实需要对结果集中的项目总数进行计数。

换句话说，Paginator 对应于simplePaginate 查询生成器和模型上的方法，而LengthAwarePaginator 对应于paginate 方法。

手动创建分页器实例时，您应该手动“切片”传递给分页器的结果数组。如果您不确定如何执行此操作，请查看array_slice PHP函数。

在视图中显示结果

当你打电话给paginate 或者simplePaginate 查询构建器或模型查询上的方法，您将收到一个分页器实例。当调用paginate 方法，您将收到一个实例Illuminate\Pagination\LengthAwarePaginator.当调用simplePaginate 方法，您将收到一个实例Illuminate\Pagination\Paginator.这些对象提供了几种描述结果集的方法。除了这些辅助方法之外，分页器实例是迭代器，可以作为数组循环。

因此，一旦检索到结果，就可以显示结果并使用 Twig 呈现页面链接：

<div class="container">
    {% for user in users %}
        {{ user.name }}
    {% endfor %}
</div>

{{ users.render|raw }}

这render 方法将呈现指向结果集中其余页面的链接。这些链接中的每一个都已经包含适当的?page 查询字符串变量。生成的 HTMLrender 方法兼容引导 CSS 框架.

NOTE: 当调用render 来自 Twig 模板的方法，一定要使用|raw过滤器，这样 HTML 链接就不会被转义。

自定义分页器 URI

这setPath 方法允许您自定义分页器在生成链接时使用的 URI。例如，如果您希望分页器生成如下链接https://example.com/custom/url?page=N，你应该通过custom/url 到setPath 方法：

$users = User::paginate(15);
$users->setPath('custom/url');

附加到分页链接

您可以使用appends 方法。例如，追加&sort=votes 对于每个分页链接，您应该进行以下调用appends:

{{ users.appends({sort: 'votes'}).render|raw }}

如果您希望将“哈希片段”附加到分页器的 URL，您可以使用fragment 方法。例如，追加#foo 在每个分页链接的末尾，对fragment 方法：

{{ users.fragment('foo').render|raw }}

额外的辅助方法

您还可以通过分页器实例上的以下方法访问其他分页信息：

$results->count()
$results->currentPage()
$results->hasMorePages()
$results->lastPage() // Not available when using simplePaginate
$results->nextPageUrl()
$results->perPage()
$results->previousPageUrl()
$results->total() // Not available when using simplePaginate
$results->url($page)

将结果转换为 JSON

分页器结果类实现了Illuminate\Contracts\Support\JsonableInterface 合同和暴露toJson 方法，因此很容易将分页结果转换为 JSON。您还可以通过简单地从路由或 AJAX 处理程序返回它来将分页器实例转换为 JSON：

Route::get('users', function () {
    return User::paginate();
});

来自分页器的 JSON 将包含元信息，例如total,current_page,last_page，和更多。实际结果对象将通过data JSON 数组中的键。以下是通过从路由返回分页器实例创建的 JSON 示例：

示例分页器 JSON

{
    "total": 50,
    "per_page": 15,
    "current_page": 1,
    "last_page": 4,
    "next_page_url": "https://wintercms.app?page=2",
    "prev_page_url": null,
    "from": 1,
    "to": 15,
    "data": [
        {
            // Result Object
        },
        {
            // Result Object
        }
    ]
}

Pagination

#基本用法

#分页查询生成器结果