設定

他のフレームワークのペジネーションは苦痛に満ちています。Laravelはこれを簡単にしてくれます。Laravelは現在のページ位置に基づいて、賢い「ページ範囲」のリンクを生成します。生成されるHTMLはBootstrap CSSフレームワークへ適合しています。

使用法

アイテムをページ分けするには多くの方法があります。一番シンプルな方法はEloquentモデルかクエリービルダーに、paginateメソッドを用いることです。

データベースの結果をペジネーションする

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

注意: 現在、groupByメソッドを使用したペジネーション操作は、Laravelで正しく実行できません。groupByを使用したペジネーションを使用する必要がある場合は、データベースクエリーを実行し、その結果でPaginator::makeを使用することをおすすめします。

Eloquentモデルをペジネーションする

さらにEloquentモデルもペジネーションできます。

$allUsers = User::paginate(15);

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

paginateメソッドに渡している引数は表示したいアイテムの個数です。一度結果を受け取ったら、それをビューで表示してください。それからrenderメソッドを使ってペジネーションリンクを生成してください。

<div class="container">
    <?php foreach ($users as $user): ?>
        <?php echo $user->name; ?>
    <?php endforeach; ?>
</div>

<?php echo $users->render(); ?>

これらの生成は全部ペジネーションシステムが面倒を見ます。フレームワークに現在ページを指定していないことに注意してください。Laravelは自動的に判断します。

さらに、以下のメソッドを使用し、追加のペジネーション情報にアクセスできます。

  • currentPage
  • lastPage
  • perPage
  • total
  • count

シンプル・ペジネーション

「次」と「前」のリンクだけをペジネーションビューに表示したい場合は、simplePaginateメソッドを使用する選択肢により、より効率的にクエリーすべきでしょう。これは、ビューに正確なページ番号を表示する必要がない、巨大なデータセットに対して便利です。

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

ペジネーターを手動で生成する

時にはアイテムを配列で渡し、手動でペジネーションインスタンスを生成したい場合もあるでしょう。必要に応じ、Illuminate\Pagination\PaginatorIlluminate\Pagination\LengthAwarePaginatorインスタンスのどちらかを生成することで、可能です。

ペジネーターでカスタムURIを使用する

ペジネーターにより使用されるURIも、setPathメソッドでカスタマイズできます。

$users = User::paginate();

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

上の例では、次のURLリンクが生成されます。http://example.com/custom/url?page=2

ペジネーションリンクの追加

ペジネーターのappendsメソッドを使用しペジネーションリンクのクエリー文字列を追加することができます。

<?php echo $users->appends(['sort' => 'votes'])->render(); ?>

この例で、以下のようなURLが生成されます。

http://example.com/something?page=2&sort=votes

ペジネーションのURLに「ハッシュフラグメント」を追加したい場合は、fragmentメソッドが使用できます。

<?php echo $users->fragment('foo')->render(); ?>

このメソッドの呼び出しで、次のようなURLが表示されます。

http://example.com/something?page=2#foo

JSONへ変換する

Paginatorクラスは、Illuminate\Contracts\Support\JsonableInterface契約を実装しており、toJsonメソッドを備えています。Paginatorインスタンスをルートから返すことにより、JSONに変換することもできます。インスタンスのJSON形式には、totalcurrent_pagelast_pageのような「メタ」情報が含まれています。インスタンスのデーターは、JSON配列のdataキーにより利用できます。