有几种方法可以对记录进行分页,最常见的是在查询或模型上调用 paginate 方法。这将返回一个特殊的分页集合,其中包含用于显示结果的额外方法。
有几种方法可以对项目进行分页。最简单的方法是使用作用于查询构建器或模型查询的paginate方法。paginate方法会自动根据用户当前查看的页面,设置合适的限制(limit)和偏移量(offset)。默认情况下,当前页面是通过HTTP请求中?page查询字符串参数的值来检测的。当然,该值会被自动检测并自动插入到分页器生成的链接中。
首先,我们来看一下在查询上调用 paginate 方法。在此示例中,传递给 paginate 的唯一参数是您希望“每页”显示的项目数。在这种情况下,我们指定每页显示 15 个项目。
$users = Db::table('users')->paginate(15);目前,使用
groupBy语句的分页操作无法高效执行。如果你需要将groupBy与分页结果集一起使用,建议你查询数据库并手动创建分页器。
如果你只需要在分页视图中显示简单的“下一页”和“上一页”链接,你可以选择使用 simplePaginate 方法来执行更高效的查询。这对于大型数据集非常有用,如果你在渲染视图时不需要为每个页码显示链接。
$users = Db::table('users')->simplePaginate(15);默认情况下,分页器将从 ?page 查询字符串中获取当前页码。你可以使用 paginateAtPage 和 simplePaginateAtPage 方法指定页码。页数(第一个参数)和当前页码(第二个参数)被一同提供。
$recordsPerPage = 15;
$currentPage = 1;
$users = Db::table('users')->paginateAtPage($recordsPerPage, $currentPage);
$users = Db::table('users')->simplePaginateAtPage($recordsPerPage, $currentPage);paginateCustom 和 simplePaginateCustom 方法用于自定义查询字符串名称。以下将使用 ?secondPage 查询字符串来确定页码。
$recordsPerPage = 15;
$users = Db::table('users')->paginateCustom($recordsPerPage, 'secondPage');
$users = Db::table('users')->simplePaginateCustom($recordsPerPage, 'secondPage');您也可以对 数据库模型 查询进行分页。在此示例中,我们将对 User 模型进行分页,每页显示 15 个项目。如您所见,其语法与对查询构建器结果进行分页几乎相同:
$users = User::paginate(15);当然,你可以在设置其他查询约束(例如 where 语句)之后调用 paginate:
$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 的一个实例。这些对象提供了几个描述结果集的方法。除了这些辅助方法之外,分页器实例还是迭代器,并且可以像数组一样循环。
因此,一旦您检索到结果,您就可以使用 PHP 或 Twig 分页函数 来显示结果并渲染页面链接。
<div class="container">
<?php foreach ($users as $user): ?>
<?= $user->name ?>
<?php endforeach ?>
</div>
<?= $users->links() ?>render 方法将渲染结果集中其余页面的链接。每个链接都已包含正确的 ?page 查询字符串变量。由 render 方法生成的 HTML 与 Bootstrap CSS 框架 兼容。
在从 Twig 模板中调用
render方法时,请务必使用|raw过滤器,以确保 HTML 链接不会被转义。
:::
该setPath方法允许您自定义分页器在生成链接时使用的 URI。 例如,如果您希望分页器生成类似于http://example.tld/custom/url?page=N` 的链接,您应该将 custom/url 传递给 setPath 方法:`
$users = User::paginate(15);
$users->setPath('custom/url');
echo $users->render();您可以使用 appends 方法向分页链接的查询字符串添加内容。例如,要将 &sort=votes 添加到每个分页链接,您应该进行以下调用来使用 appends。
echo $users->appends(['sort' => 'votes'])->render();如果您希望将“哈希片段”附加到分页器的 URL,您可以使用 fragment 方法。例如,要将 #foo 附加到每个分页链接的末尾,请对 fragment 方法进行以下调用。
echo $users->fragment('foo')->render();您还可以通过分页器实例上的以下方法访问额外的分页信息:
$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)分页器结果类实现了 Illuminate\Contracts\Support\JsonableInterface 契约,并暴露了 toJson 方法,因此将分页结果转换为 JSON 变得非常容易。您还可以通过从路由或 AJAX 处理器简单地返回分页器实例,将其转换为 JSON:
Route::get('users', function () {
return User::paginate();
});分页器返回的 JSON 将包含元信息,例如 total、current_page、last_page 等。实际的结果对象将通过 JSON 数组中的 data 键可用。以下是路由返回分页器实例时创建的 JSON 示例:
{
"total": 50,
"per_page": 15,
"current_page": 1,
"last_page": 4,
"next_page_url": "http://octobercms.app?page=2",
"prev_page_url": null,
"from": 1,
"to": 15,
"data":[
{
// Result Object
},
{
// Result Object
}
]
}