Laravel 5.2 中文文档

简体中文

English

简体中文

English

主题

分页 ​

介绍 ​

在其他框架中，分页可能非常麻烦。Laravel让它变得轻而易举。Laravel可以快速生成基于当前页面的智能“范围”链接，并且生成的HTML与Bootstrap CSS框架兼容。

基本用法 ​

分页查询构建器结果 ​

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

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

php
<?php

namespace App\Http\Controllers;

use DB;
use App\Http\Controllers\Controller;

class UserController extends Controller
{
    /**
     * 显示应用程序的所有用户。
     *
     * @return Response
     */
    public function index()
    {
        $users = DB::table('users')->paginate(15);

        return view('user.index', ['users' => $users]);
    }
}
lightbulb

目前，使用groupBy语句的分页操作无法由Laravel高效执行。如果您需要使用groupBy与分页结果集，建议您查询数据库并手动创建分页器。

“简单分页” ​

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

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

分页Eloquent结果 ​

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

php
$users = App\User::paginate(15);

当然，您可以在设置查询的其他约束（如where子句）后调用paginate：

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

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

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

手动创建分页器 ​

有时您可能希望手动创建分页实例，传递一个项目数组。您可以通过创建Illuminate\Pagination\Paginator或Illuminate\Pagination\LengthAwarePaginator实例来实现，具体取决于您的需求。

Paginator类不需要知道结果集中的项目总数；然而，由于这个原因，该类没有用于检索最后一页索引的方法。LengthAwarePaginator接受几乎与Paginator相同的参数；然而，它确实需要结果集中的项目总数。

换句话说，Paginator对应于查询构建器和Eloquent上的simplePaginate方法，而LengthAwarePaginator对应于paginate方法。

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

在视图中显示结果 ​

当您在查询构建器或Eloquent查询上调用paginate或simplePaginate方法时，您将收到一个分页器实例。调用paginate方法时，您将收到一个Illuminate\Pagination\LengthAwarePaginator实例。调用simplePaginate方法时，您将收到一个Illuminate\Pagination\Paginator实例。这些对象提供了几个描述结果集的方法。除了这些辅助方法外，分页器实例是迭代器，可以像数组一样循环。

因此，一旦您检索到结果，您可以使用Blade显示结果并渲染页面链接：

php
<div class="container">
    @foreach ($users as $user)
        {{ $user->name }}
    @endforeach
</div>

{{ $users->links() }}

links方法将渲染结果集中其余页面的链接。每个链接都将包含正确的?page查询字符串变量。请记住，links方法生成的HTML与Bootstrap CSS框架兼容。

自定义分页器URI ​

setPath方法允许您自定义分页器在生成链接时使用的URI。例如，如果您希望分页器生成类似http://example.com/custom/url?page=N的链接，您应该将custom/url传递给setPath方法：

php
Route::get('users', function () {
    $users = App\User::paginate(15);

    $users->setPath('custom/url');

    //
});

附加到分页链接 ​

您可以使用appends方法向分页链接的查询字符串添加内容。例如，要将&sort=votes附加到每个分页链接，您应该对appends进行以下调用：

php
{{ $users->appends(['sort' => 'votes'])->links() }}

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

php
{{ $users->fragment('foo')->links() }}

其他辅助方法 ​

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

  • $results->count()
  • $results->currentPage()
  • $results->firstItem()
  • $results->hasMorePages()
  • $results->lastItem()
  • $results->lastPage() (使用simplePaginate时不可用)
  • $results->nextPageUrl()
  • $results->perPage()
  • $results->previousPageUrl()
  • $results->total() (使用simplePaginate时不可用)
  • $results->url($page)

将结果转换为JSON ​

Laravel分页器结果类实现了Illuminate\Contracts\Support\JsonableInterface合同，并公开了toJson方法，因此将分页结果转换为JSON非常简单。

您还可以通过简单地从路由或控制器操作返回分页器实例来将其转换为JSON：

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

分页器的JSON将包括诸如total、current_page、last_page等元信息。实际的结果对象将通过JSON数组中的data键提供。以下是从路由返回分页器实例创建的JSON示例：

分页器JSON示例 ​

php
{
   "total": 50,
   "per_page": 15,
   "current_page": 1,
   "last_page": 4,
   "next_page_url": "http://laravel.app?page=2",
   "prev_page_url": null,
   "from": 1,
   "to": 15,
   "data":[
        {
            // 结果对象
        },
        {
            // 结果对象
        }
   ]
}

版权所有 © 2024-2025 laravel.wiki