【PHP8.x】PDO::FETCH_ORI_LAST定数の使い方

Copy
1<?php
2
3/**
4 * PDO::FETCH_ORI_LAST と PDO::FETCH_OBJ を使用して、
5 * 結果セットの最後の行をオブジェクトとして取得する方法を示す関数です。
6 * システムエンジニアを目指す初心者にも理解しやすいように作成されています。
7 */
8function demonstratePdoFetchLastAsObject(): void
9{
10    // SQLiteのインメモリデータベースを使用します。
11    // PDO::ATTR_ERRMODE: エラー発生時にPDOExceptionをスローするよう設定します。
12    // PDO::ATTR_CURSOR: スクロール可能なカーソルを有効にします。
13    //                   これにより、結果セット内を前後や特定の位置に移動できるようになります。
14    $dsn = 'sqlite::memory:';
15    $options = [
16        PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
17        PDO::ATTR_CURSOR => PDO::CURSOR_SCROLL,
18    ];
19
20    try {
21        // PDOオブジェクトを生成し、データベースに接続します。
22        $pdo = new PDO($dsn, null, null, $options);
23
24        // サンプル用の `products` テーブルを作成します。
25        $pdo->exec("
26            CREATE TABLE IF NOT EXISTS products (
27                id INTEGER PRIMARY KEY AUTOINCREMENT,
28                name TEXT NOT NULL,
29                price INTEGER NOT NULL
30            )
31        ");
32
33        // サンプルデータを挿入します。
34        $insertStmt = $pdo->prepare("INSERT INTO products (name, price) VALUES (?, ?)");
35        $insertStmt->execute(['Laptop', 120000]);
36        $insertStmt->execute(['Mouse', 3000]);
37        $insertStmt->execute(['Keyboard', 8000]);
38        $insertStmt->execute(['Monitor', 25000]);
39
40        echo "--- PDO::FETCH_ORI_LAST と PDO::FETCH_OBJ のデモンストレーション ---\n";
41
42        // `products` テーブルからすべてのデータを取得するSELECTステートメントを準備・実行します。
43        // PDOオブジェクトのオプションでスクロール可能なカーソルが有効になっています。
44        $selectStmt = $pdo->prepare("SELECT id, name, price FROM products ORDER BY id ASC");
45        $selectStmt->execute();
46
47        // PDO::FETCH_OBJ: フェッチした行を匿名オブジェクトとして返します。
48        //                 オブジェクトのプロパティ名は、データベースのカラム名に対応します。
49        // PDO::FETCH_ORI_LAST: カーソルを結果セットの最後の行に移動させ、その行をフェッチします。
50        $lastProduct = $selectStmt->fetch(PDO::FETCH_OBJ, PDO::FETCH_ORI_LAST);
51
52        if ($lastProduct) {
53            echo "取得された最後の製品:\n";
54            echo "ID: " . $lastProduct->id . "\n";
55            echo "名前: " . $lastProduct->name . "\n";
56            echo "価格: " . $lastProduct->price . "円\n";
57        } else {
58            echo "製品が見つからなかったか、最後の製品を取得できませんでした。\n";
59        }
60
61    } catch (PDOException $e) {
62        // データベース関連のエラーが発生した場合に、メッセージを表示します。
63        echo "データベースエラー: " . $e->getMessage() . "\n";
64    }
65}
66
67// 上記のデモンストレーション関数を実行します。
68demonstratePdoFetchLastAsObject();

このPHPサンプルコードは、PDO拡張機能を利用してデータベースからデータを取得する際、特に結果セットの最後の行をオブジェクト形式で取得する方法を示しています。

PDO::FETCH_ORI_LASTは、PDOStatement::fetch()メソッドの引数に指定することで、データベースカーソルを結果セットの末尾（最後の行）に移動させ、その行をフェッチするようPDOに指示する定数です。引数はなく内部的には整数値ですが、このように特定のフェッチ方向を指定する役割を果たします。

同時に使用されているPDO::FETCH_OBJも、同じくfetch()メソッドの引数として利用され、フェッチした行のデータを匿名オブジェクトとして返すことを指定します。これにより、データベースのカラム名がオブジェクトのプロパティ名として扱われ、例えば$object->column_nameのように直感的にデータにアクセスできます。

これらの定数を効果的に利用するには、PDOオブジェクトを生成する際にPDO::ATTR_CURSORオプションをPDO::CURSOR_SCROLLに設定し、スクロール可能なカーソルを有効にする必要があります。サンプルでは、SQLiteのインメモリデータベースに接続し、製品データを挿入した後、SELECT文で取得した結果セットから、PDO::FETCH_ORI_LASTとPDO::FETCH_OBJの組み合わせで最後の製品情報をオブジェクトとして取得し、その詳細を表示しています。これにより、データベース操作における柔軟なデータ取得方法を学ぶことができます。

Copy
1<?php
2
3/**
4 * PDO::FETCH_ORI_LAST 定数を使用して、データベースの結果セットの最後の行を取得するサンプル。
5 *
6 * この定数は PDOStatement::fetch() メソッドの第2引数 (orientation) で使用され、
7 * カーソルを結果セットの特定の行 (この場合は最後の行) に移動させます。
8 * カーソルがサポートされているデータベースドライバ (例: SQLite, PostgreSQL) で有効です。
9 * (fetchAll() メソッドではこの定数は使用できません。)
10 */
11function demonstratePdoFetchOriLast(): void
12{
13    try {
14        // SQLite のインメモリデータベースに接続。
15        // ファイルを作成せずメモリ上で動作するため、単体で手軽に試せます。
16        $pdo = new PDO('sqlite::memory:');
17
18        // エラーモードを例外に設定し、データベース操作でエラーが発生した場合に
19        // PDOException がスローされるようにします。
20        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
21
22        // テスト用の 'users' テーブルを作成します。
23        $pdo->exec("
24            CREATE TABLE users (
25                id INTEGER PRIMARY KEY AUTOINCREMENT,
26                name TEXT NOT NULL
27            )
28        ");
29
30        // サンプルデータを複数行挿入します。
31        $pdo->exec("INSERT INTO users (name) VALUES ('Alice')");
32        $pdo->exec("INSERT INTO users (name) VALUES ('Bob')");
33        $pdo->exec("INSERT INTO users (name) VALUES ('Charlie')");
34
35        // 全てのユーザーを取得するSQLステートメントを準備し、実行します。
36        // ORDER BY を使用して、結果の順序を明確にします。
37        $stmt = $pdo->prepare("SELECT id, name FROM users ORDER BY id ASC");
38        $stmt->execute();
39
40        // PDO::FETCH_ORI_LAST を使用して、結果セットの最後の行を取得します。
41        // 第1引数: PDO::FETCH_ASSOC は結果を連想配列として返します。
42        // 第2引数: PDO::FETCH_ORI_LAST はカーソルを結果セットの末尾に移動させ、その行を取得します。
43        $lastRow = $stmt->fetch(PDO::FETCH_ASSOC, PDO::FETCH_ORI_LAST);
44
45        if ($lastRow) {
46            echo "結果セットから取得した最後のユーザー情報:" . PHP_EOL;
47            echo "  ID: " . $lastRow['id'] . PHP_EOL;
48            echo "  名前: " . $lastRow['name'] . PHP_EOL;
49        } else {
50            echo "結果セットにデータが見つからなかったか、最後の行を取得できませんでした。" . PHP_EOL;
51        }
52
53    } catch (PDOException $e) {
54        // データベース関連のエラーが発生した場合に、エラーメッセージを表示します。
55        echo "データベースエラーが発生しました: " . $e->getMessage() . PHP_EOL;
56    } catch (Exception $e) {
57        // その他の予期せぬエラーが発生した場合に、エラーメッセージを表示します。
58        echo "予期せぬエラーが発生しました: " . $e->getMessage() . PHP_EOL;
59    }
60}
61
62// 上記で定義した関数を実行します。
63demonstratePdoFetchOriLast();
64

PDO::FETCH_ORI_LASTは、PHPでデータベースを扱う際に使用するPDO拡張モジュールが提供する定数です。この定数自体には引数はなく、内部的には整数値（integer）として定義されています。

この定数の主な役割は、データベースから取得した結果セットの「最後の行」を効率的に取得することです。具体的には、PDOStatement::fetch()メソッドの第2引数としてPDO::FETCH_ORI_LASTを指定することで、カーソルを結果セットの末尾に移動させ、その行のデータを取得します。この機能は、カーソルをサポートするデータベースドライバ（SQLiteやPostgreSQLなど）で有効です。なお、複数の行をまとめて取得するPDOStatement::fetchAll()メソッドではこの定数を使用できませんのでご注意ください。

サンプルコードでは、まずSQLiteのインメモリデータベースに接続し、エラーモードを設定してからusersテーブルを作成し、複数のサンプルデータを挿入しています。その後、SELECT文を実行して結果セットを準備し、PDO::FETCH_ASSOC（結果を連想配列として取得）とPDO::FETCH_ORI_LASTを組み合わせて、結果セットから最後のユーザー情報のみを抽出し、その内容を出力しています。エラー発生時にはPDOExceptionを捕捉し、適切なメッセージを表示する堅牢な処理も含まれています。