PEAR::Pager - 大きなデータをページング処理で分割する

PEAR::Pagerとは？

掲示板などの大きなデータを一気に1ページで表示すると、ページが非常に長くなってしまいます。
そのような大きなデータを持つページを何ページかに分けて表示することをページング処理といいます。

例えば、検索エンジンの検索結果もページング処理がされています。
PEAR::PagerはPHPでそのようなページング処理を行うためのライブラリです。

PEAR::Pagerのインストール

pear list コマンドでインストール済みのライブラリを確認できます。
その一覧の中に Pager がない場合は下記コマンドでインストールを実行します。

# pear install pager

Pagerの使い方

テストスクリプト

下記のテストスクリプトを使って Pager の挙動を確認してみましょう。

<?php
require_once("Pager/Pager.php");    // ライブラリの読み込み

// ページングの対象となるアイテムの配列を定義
for ($i = 1; $i <= 1000; $i++) {
    $items[$i]['title'] = $i . "番目のタイトル";
    $items[$i]['content'] = $i . "番目の本文";
}

// パラメータを定義
$params = array(
    "itemData" => $items,
    "perPage" => 20,
    "delta" => 10,
    "firstPagePre"=> "{",
    "firstPageText"=> "最初",
    "firstPagePost"=> "}",
    "lastPagePre"=> "{",
    "lastPageText"=> "最後",
    "lastPagePost"=> "}",
);

// ページング情報の取得
$pager = Pager::factory($params);    //上記で定義したパラメータを引数にインスタンスを生成
$navi = $pager->getLinks();    // ナビゲーションリンクを取得
$scope = $pager->getOffsetByPageId();// オフセットの取得
$data = $pager->getPageData();// 現在のページのデータを取得

// 以下HTML出力部分
echo "{$navi['all']}<br />\n";
echo $pager->numItems() . "件中<br />\n";
echo $scope['0'] . "件目から" . $scope['1'] . "件目を表示 <br/>\n";
echo "<table>\n";
foreach ($data as $key => $value) {
    echo "<tr><th>{$value['title']}</th><td>{$value['content']}</td></tr>\n";
}
echo "</table>\n";
echo "{$navi['all']}<br />\n";

パラメータの解説

テストスクリプトで factoryメソッド を実行してインスタンスを生成する際にいくつかパラメータを渡していましたが、それらの意味は下記の様になります。

上記は一部に過ぎません。さらに詳しく見たい場合は公式マニュアル(下記URL)が参考になります。
http://pear.php.net/manual/ja/package.html.pager.factory.php

メソッドの解説

Pager によって生成されたナビゲーションリンクは getLinksメソッド で取得することができます。

getLinksメソッド は連想配列で「戻る/次/最初/最後のリンクとページリンク」をそれぞれ返します。下表に大まかにまとめます。

また、アイテム数やページ数などの情報を取得するための下記の様なメソッドが用意されています。

参考資料

• Manual :: Pager
• ページング(PEAR::Pager) - PEAR入門
• PEARの基本的な使い方１～Pagerでページ送りを使う～ - WEBシステム開発の情報サイト