服務 —— 分頁

1、簡介

在其他框架中，分頁是件非常痛苦的事，Laravel則使其變得輕而易舉。Laravel能夠基于當前頁智能生成一定范圍的鏈接，且生成的HTML兼容Bootstrap CSS 框架。

2、基本使用

2.1 基于查詢構建器分頁

有多種方式實現(xiàn)分頁，最簡單的方式就是使用查詢構建器或Eloquent模型的paginate方法。該方法基于當前用戶查看頁自動設置合適的偏移（offset）和限制（limit）。默認情況下，當前頁通過HTTP請求查詢字符串參數(shù)?page的值判斷。當然，該值由Laravel自動檢測，然后自動插入分頁器生成的鏈接中。

讓我們先來看看如何在查詢上調用paginate方法。在本例中，傳遞給paginate的唯一參數(shù)就是你每頁想要顯示的數(shù)目，這里我們指定每頁顯示15個：

<?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]);
    }
}

注意：目前，使用groupBy的分頁操作不能被Laravel有效執(zhí)行，如果你需要在分頁結果中使用groupBy，推薦你手動查詢數(shù)據(jù)庫然后創(chuàng)建分頁器。

2.1.1 “簡單分頁”

如果你只需要在分頁視圖中簡單的顯示“下一個”和“上一個”鏈接，可以使用simplePaginate方法來執(zhí)行該查詢。在渲染包含大數(shù)據(jù)集的視圖且不需要顯示每個頁碼時非常有用：

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

2.2 基于Eloquent模型分頁

你還可以對Eloquent查詢結果進行分頁，在本例中，我們對User模型進行分頁，每頁顯示15條記錄。正如你所看到的，該語法和基于查詢構建器的分頁差不多：

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

當然，你可以在設置其它約束調價之后調用paginate，比如where子句：

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

你也可以使用simplePaginate方法：

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

2.3 手動創(chuàng)建分頁器

有時候你可能想要通過傳遞數(shù)組數(shù)據(jù)來手動創(chuàng)建分頁實例，你可以基于自己的需求通過創(chuàng)建Illuminate\Pagination\Paginator或Illuminate\Pagination\LengthAwarePaginator實例來實現(xiàn)。

Paginator類不需要知道結果集中數(shù)據(jù)項的總數(shù)；然而，正因如此，該類也沒有提供獲取最后一頁索引的方法。

LengthAwarePaginator接收參數(shù)和Paginator幾乎一樣，只是，它要求傳入結果集的總數(shù)。

換句話說，Paginator?對應simplePaginate方法，而LengthAwarePaginator對應paginate方法。

當手動創(chuàng)建分頁器實例的時候，應該手動對傳遞到分頁器的結果集進行“切片”，如果你不確定怎么做，查看PHP函數(shù)array_slice。

3、在視圖中顯示分頁結果

當你調用查詢構建器或Eloquent查詢上的paginate或simplePaginate方法時，你將會獲取一個分頁器實例。當調用paginate方法時，你將獲取Illuminate\Pagination\LengthAwarePaginator，而調用方法simplePaginate時，將會獲取Illuminate\Pagination\Paginator實例。這些對象提供相關方法描述這些結果集，除了這些幫助函數(shù)外，分頁器實例本身就是迭代器，可以像數(shù)組一樣對其進行循環(huán)調用。

所以，獲取到結果后，可以按如下方式使用Blade顯示這些結果并渲染頁面鏈接：

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

{!! $users->render() !!}

render方法將會將結果集中的其它頁面鏈接渲染出來。每個鏈接已經(jīng)包含了?page查詢字符串變量。記住，render方法生成的HTML兼容Bootstrap CSS 框架。

注意：我們從Blade模板調用render方法時，確保使用{!!?!!}語法以便HTML鏈接不被過濾。

3.1 自定義分頁器URI

setPath方法允許你生成分頁鏈接時自定義分頁器使用的URI，例如，如果你想要分頁器生成形如http://example.com/custom/url?page=N的鏈接，應該傳遞custom/url到setPath方法：

Route::get('users', function () {
    $users = App\User::paginate(15);
    $users->setPath('custom/url');
    //
});

3.2 添加參數(shù)到分頁鏈接

你可以使用appends方法添加查詢參數(shù)到分頁鏈接查詢字符串。例如，要添加&sort=votes到每個分頁鏈接，應該像如下方式調用appends：

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

如果你想要添加”哈希片段”到分頁鏈接，可以使用fragment方法。例如，要添加#foo到每個分頁鏈接的末尾，像這樣調用fragment方法：

{!! $users->fragment('foo')->render() !!}

3.3 更多幫助方法

你還可以通過如下分頁器實例上的方法訪問更多分頁信息：

• $results->count()
• $results->currentPage()
• $results->hasMorePages()
• $results->lastPage() (使用simplePaginate時無效)
• $results->nextPageUrl()
• $results->perPage()
• $results->total() (使用simplePaginate時無效)
• $results->url($page)

4、將結果轉化為JSON

Laravel分頁器結果類實現(xiàn)了Illuminate\Contracts\Support\JsonableInterface契約并實現(xiàn)toJson方法，所以將分頁結果轉化為JSON非常簡單。

你還可以簡單通過從路由或控制器動作返回分頁器實例將轉其化為JSON：

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

從分頁器轉化來的JSON包含了元信息如total,?current_page,last_page等等，實際的結果對象數(shù)據(jù)可以通過該JSON數(shù)組中的data鍵訪問。下面是一個通過從路由返回的分頁器實例創(chuàng)建的JSON例子：

{
   "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":[
        {
            // Result Object
        },
        {
            // Result Object
        }
   ]
}