設定

他のフレームワークではペジネーションは苦痛に満ちています。Laravelでは簡単です。app/config/view.phpに一つのオプションがあるだけです。paginationオプションはペジネーションリンクを作成するために、どのビューを使用するかを指定します。デフォルトで2つのビューをLaravelは持っています。

pagination::sliderは現在のページに基づいて知的にリンクの「範囲」を表示します。pagination::simpleはシンプルに「前」と「次」ボタンを表示します。両方のビューは最初からTwitter Bootstrapとコンパチブルです。

使用法

アイテムをページ分けするには多くの方法があります。一番シンプルな方法は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メソッドに渡している引数は表示したいアイテムの個数です。一度結果を受け取ったら、それをビューで表示してください。それからlinksメソッドを使ってペジネーションリンクを生成してください。

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

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

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

ペジネーションでカスタムビューを指定したい場合は、linksメソッドでビューを指定して下さい。

<?php echo $users->links('view.name'); ?>

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

  • getCurrentPage
  • getLastPage
  • getPerPage
  • getTotal
  • getFrom
  • getTo
  • count

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

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

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

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

時には手動でペジネーションインスタンスを生成したい場合もあるでしょう。その場合はPaginator::makeを使います。

$paginator = Paginator::make($items, $totalItems, $perPage);

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

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

$users = User::paginate();

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

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

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

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

<?php echo $users->appends(array('sort' => 'votes'))->links(); ?>

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

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

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

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

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

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

JSONへ変換する

PaginatorクラスはIlluminate\Support\Contracts\JsonableInterface契約を実装しており、toJsonメソッドを提供しています。ルートからPaginatorインスタンスをリターンすれば、JSONに変換されます。インスタンスが変換された後のJSONには、totalcurrent_pagelast_pagefromtoのような「メタ」情報を含みます。インスタンスの情報はJSON配列のdataキーで利用できます。

カスタム・プレゼンター

初めからLaravelに用意されている、デフォルトのペジネーションプレゼンターは、Bootstrapと互換性があります。しかし、皆さんが選んだプレゼンテーターに合わせ、カスタマイズすることができます。

Abstractのプレゼンターを拡張する

Illuminate\Pagination\Presenterクラスを拡張し、抽象メソッドを実装してください。例えば、ZurbのFoundationでは、次のようになるでしょう。

class ZurbPresenter extends Illuminate\Pagination\Presenter {

    public function getActivePageWrapper($text)
    {
        return '<li class="current"><a href="">'.$text.'</a></li>';
    }

    public function getDisabledTextWrapper($text)
    {
        return '<li class="unavailable"><a href="">'.$text.'</a></li>';
    }

    public function getPageLinkWrapper($url, $page, $rel = null)
    {
        return '<li><a href="'.$url.'">'.$page.'</a></li>';
    }

}

カスタムプレゼンターを使用する

最初に、カスタムプレゼンターとして働くビューをapp/viewsディレクトリーの中に作成してください。次に、app/config/view.php設定ファイルの、paginationオプションへ新しいビューの名前を指定します。最後に、以下のコードをカスタムプレゼンタービューに、設置してください。

<ul class="pagination">
    <?php echo with(new ZurbPresenter($paginator))->render(); ?>
</ul>