数据库：分页

介绍
基本用法
显示分页结果
- 将结果转换为JSON
自定义分页视图
- 使用Tailwind
分页器实例方法

介绍

在其他框架中，分页可能非常痛苦。Laravel的分页器与查询构建器和Eloquent ORM集成，提供了方便、易于使用的数据库结果分页功能。分页器生成的HTML与Bootstrap CSS框架兼容。

基本用法

分页查询构建器结果

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

在此示例中，传递给paginate方法的唯一参数是您希望每页显示的项目数。在这种情况下，我们指定每页显示15个项目：

php

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use Illuminate\Support\Facades\DB;

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

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

NOTE

目前，使用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方法。

NOTE

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

显示分页结果

调用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

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

php

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

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

    //
});

附加到分页链接

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

php

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

如果希望将所有当前查询字符串值附加到分页链接，可以使用withQueryString方法：

php

{{ $users->withQueryString()->links() }}

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

php

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

调整分页链接窗口

您可以控制在分页器的URL“窗口”每侧显示多少个附加链接。默认情况下，每侧显示三个链接。然而，您可以使用onEachSide方法控制此数字：

php

{{ $users->onEachSide(5)->links() }}

将结果转换为JSON

Laravel分页器结果类实现了Illuminate\Contracts\Support\Jsonable接口合同，并公开了toJson方法，因此将分页结果转换为JSON非常简单。您还可以通过从路由或控制器操作返回分页器实例来将其转换为JSON：

php

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

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

php

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

自定义分页视图

默认情况下，渲染以显示分页链接的视图与Bootstrap CSS框架兼容。然而，如果您不使用Bootstrap，可以自由定义自己的视图来渲染这些链接。在分页器实例上调用links方法时，将视图名称作为方法的第一个参数传递：

php

{{ $paginator->links('view.name') }}

// 向视图传递数据...
{{ $paginator->links('view.name', ['foo' => 'bar']) }}

然而，自定义分页视图的最简单方法是使用vendor:publish命令将其导出到resources/views/vendor目录：

php

php artisan vendor:publish --tag=laravel-pagination

此命令会将视图放置在resources/views/vendor/pagination目录中。此目录中的bootstrap-4.blade.php文件对应于默认分页视图。您可以编辑此文件以修改分页HTML。

如果希望将不同的文件指定为默认分页视图，可以在AppServiceProvider中使用分页器的defaultView和defaultSimpleView方法：

php

use Illuminate\Pagination\Paginator;

public function boot()
{
    Paginator::defaultView('view-name');

    Paginator::defaultSimpleView('view-name');
}

使用Tailwind

Laravel包含使用Tailwind CSS构建的分页视图。要使用这些视图而不是默认的Bootstrap视图，可以在AppServiceProvider中调用分页器的useTailwind方法：

php

use Illuminate\Pagination\Paginator;

public function boot()
{
    Paginator::useTailwind();
}

分页器实例方法

每个分页器实例通过以下方法提供额外的分页信息：

方法	描述
`$paginator->count()`	获取当前页面的项目数。
`$paginator->currentPage()`	获取当前页码。
`$paginator->firstItem()`	获取结果中第一个项目的结果编号。
`$paginator->getOptions()`	获取分页器选项。
`$paginator->getUrlRange($start, $end)`	创建分页URL范围。
`$paginator->hasPages()`	确定是否有足够的项目拆分为多个页面。
`$paginator->hasMorePages()`	确定数据存储中是否有更多项目。
`$paginator->items()`	获取当前页面的项目。
`$paginator->lastItem()`	获取结果中最后一个项目的结果编号。
`$paginator->lastPage()`	获取最后一个可用页面的页码。（使用`simplePaginate`时不可用）。
`$paginator->nextPageUrl()`	获取下一页的URL。
`$paginator->onFirstPage()`	确定分页器是否在第一页。
`$paginator->perPage()`	每页显示的项目数。
`$paginator->previousPageUrl()`	获取上一页的URL。
`$paginator->total()`	确定数据存储中匹配项目的总数。（使用`simplePaginate`时不可用）。
`$paginator->url($page)`	获取给定页码的URL。
`$paginator->getPageName()`	获取用于存储页面的查询字符串变量。
`$paginator->setPageName($name)`	设置用于存储页面的查询字符串变量。

数据库：分页 ​

介绍 ​

基本用法 ​

分页查询构建器结果 ​

"简单分页" ​

分页Eloquent结果 ​

手动创建分页器 ​

显示分页结果 ​

自定义分页器URI ​

附加到分页链接 ​

调整分页链接窗口 ​

将结果转换为JSON ​

自定义分页视图 ​

使用Tailwind ​

分页器实例方法 ​