ページネーションを共通部品にする

ARTICLESで作ったページネーションを共通部品にまとめ、COLUMNSでも同じ処理を使えるようにします。

🎯 目的

025では、ARTICLESにページネーションを作りました。

しかし、同じページネーションをCOLUMNSでも使う場合、 同じコードをそれぞれのページに書くことになります。

そこで今回は、ページネーションの処理を pagination.phpという共通部品にまとめます。

今回やること

  1. ページネーションの処理を共通ファイルにまとめる
  2. ARTICLESから共通部品を呼び出す
  3. COLUMNSからも同じ共通部品を呼び出す
ARTICLES
↓
pagination.php
↑
COLUMNS

今回の仕組み

ARTICLESとCOLUMNSでは、ページネーションの処理そのものは同じです。

ただし、ページ番号をクリックしたときのURLは異なります。

そこで、URLのようにページごとに違う部分は各ページから渡し、 ページ番号を計算する処理や「前」「次」を表示する処理は pagination.phpにまとめます。

STEP 1|ページネーションを共通部品にする

まず、025でARTICLESに書いたページネーションの処理を、 pagination.phpという別ファイルにまとめます。

<?php

$startPage = max(1, $page - 1);
$endPage = min($totalPages, $startPage + 2);

$startPage = max(1, $endPage - 2);

?>

<?php if ($totalPages > 1): ?>

    <nav
        class="pagination"
        aria-label="ページ"
    >

        <?php if ($startPage > 1): ?>

            <a href="<?= $paginationBaseUrl ?>&page=<?= $startPage - 1 ?>">
                前
            </a>

        <?php endif; ?>


        <?php for ($i = $startPage; $i <= $endPage; $i++): ?>

            <?php if ($i === $page): ?>

                <span
                    class="current"
                    aria-current="page"
                >
                    <?= $i ?>
                </span>

            <?php else: ?>

                <a href="<?= $paginationBaseUrl ?>&page=<?= $i ?>">
                    <?= $i ?>
                </a>

            <?php endif; ?>

        <?php endfor; ?>


        <?php if ($endPage < $totalPages): ?>

            <a href="<?= $paginationBaseUrl ?>&page=<?= $endPage + 1 ?>">
                次
            </a>

        <?php endif; ?>

    </nav>

<?php endif; ?>
📘 PHPを読む

$startPage = 表示するページ番号の開始位置
$endPage = 表示するページ番号の終了位置
$page = 現在のページ番号
$totalPages = 全ページ数
$paginationBaseUrl = ページごとに変わるURLの共通部分
if = 条件によって処理を分ける
for = 同じ処理を繰り返す

→ ページ番号を計算する処理と、 「前」「ページ番号」「次」を表示する処理を、 1つのPHPファイルにまとめています。
📘 HTMLを読む

<nav> = ナビゲーション部分を表すHTML要素
<a> = リンクを作るHTML要素
<span> = 一部分をまとめるHTML要素
aria-label = ナビゲーションの目的を支援技術へ伝える属性

→ HTMLでは、ページ移動のためのナビゲーションを作っています。

STEP 2|ARTICLESから共通部品を呼び出す

次に、ARTICLES側でページネーションのURLを用意し、 pagination.phpを読み込みます。

<?php

$paginationBaseUrl =
    '/articles.php?project=' . urlencode($project);

include __DIR__ . '/pagination.php';

?>
📘 PHPを読む

$paginationBaseUrl = ページネーションのリンク先の基本URL
$project = ARTICLESで選択しているプロジェクト
urlencode() = 値をURLで安全に扱える形へ変換する
include = 別のPHPファイルを読み込む
__DIR__ = 現在のPHPファイルがあるディレクトリ

→ ARTICLES側で「自分の場合のURL」を用意し、 共通処理であるpagination.phpを読み込んでいます。

STEP 3|COLUMNSからも同じ部品を呼び出す

COLUMNSでも、ページネーションそのものは同じです。 ただし、URLにはtypeを使います。

<?php

$paginationBaseUrl =
    '/columns.php?type=' . urlencode($type);

include __DIR__ . '/pagination.php';

?>
📘 PHPを読む

$type = COLUMNSの種類を表す値
$paginationBaseUrl = COLUMNS用のページネーションURL
include = 共通のPHPファイルを読み込む

→ ARTICLESとCOLUMNSではURLだけが違います。 その違いを各ページ側で用意し、 同じページネーション処理を使い回しています。
📘 PHPを読む:共通部分と個別部分

$paginationBaseUrl = 個別ページで用意する部分
pagination.php = ARTICLESとCOLUMNSで共通して使う部分

→ 「違うところは外から渡す」「同じところは共通部品にする」 という考え方でコードを整理しています。

📘 前の記事とのつながり

025|ページネーションを作る
ARTICLESにページネーションを作りました。

今回
025で作ったページネーションを、 ARTICLESとCOLUMNSの両方から使える共通部品にしました。

→ 「作る」から「共通化する」へ進みました。

📘 処理の流れを読む

入力: ページ番号、全ページ数、ページごとのURL
↓
処理: 各ページから共通部品を呼び出し、 ページネーションを生成する
↓
出力: ARTICLESとCOLUMNSに同じ仕組みのページネーションを表示

→ 「入力 → 処理 → 出力」で整理すると、 共通部品がどのように使われているのか見えやすくなります。

📝 今回の忘備録

共通化するときは、すべてを同じにする必要はありません。

ARTICLESとCOLUMNSではURLが違うため、 その部分だけを$paginationBaseUrlとして 各ページから渡しました。

一方、ページ番号の計算や「前」「次」の表示は共通なので、 pagination.phpにまとめました。

同じコードを何度も書くのではなく、 「どこが同じで、どこが違うのか」を考えることが、 コードを整理するときのポイントです。

この先やること

タグ: PHP / include / 共通部品 / ページネーション / リファクタリング / Web制作