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

Copy
1<?php
2
3/**
4 * PDO::FETCH_ORI_REL 定数と PDO::FETCH_OBJ を使用して、
5 * データベースから相対的な位置にあるレコードをオブジェクトとして取得する方法を示すサンプルコードです。
6 *
7 * PDO::FETCH_ORI_REL は、PDOStatement::fetch() メソッドの $orientation 引数で使用され、
8 * 現在のカーソル位置から指定されたオフセットだけ移動します。
9 * この定数を使用するには、PDO接続時に PDO::ATTR_CURSOR => PDO::CURSOR_SCROLL を設定し、
10 * スクロール可能なカーソルを有効にする必要があります。
11 */
12function demonstratePdoFetchRelativeObject(): void
13{
14    // データベース接続情報 (SQLite インメモリデータベースを使用)
15    // 初心者向け: 実際のプロジェクトでは、DSN、ユーザー名、パスワードを適切に設定します。
16    $dsn = 'sqlite::memory:'; // メモリ上に一時的なSQLiteデータベースを作成
17    $user = null; // SQLiteインメモリではユーザー名・パスワードは不要
18    $password = null;
19
20    try {
21        // PDOインスタンスを作成し、データベースに接続
22        // PDO::ATTR_ERRMODE を PDO::ERRMODE_EXCEPTION に設定し、エラーを例外として処理します。
23        // PDO::ATTR_CURSOR を PDO::CURSOR_SCROLL に設定し、スクロール可能なカーソルを有効にします。
24        // PDO::FETCH_ORI_REL を使用するには、スクロール可能なカーソルが必須です。
25        $pdo = new PDO($dsn, $user, $password, [
26            PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
27            PDO::ATTR_CURSOR => PDO::CURSOR_SCROLL,
28        ]);
29
30        // サンプルテーブルを作成し、データを挿入
31        $pdo->exec("
32            CREATE TABLE IF NOT EXISTS users (
33                id INTEGER PRIMARY KEY AUTOINCREMENT,
34                name TEXT NOT NULL,
35                email TEXT NOT NULL UNIQUE
36            );
37            INSERT INTO users (name, email) VALUES ('Alice', 'alice@example.com');
38            INSERT INTO users (name, email) VALUES ('Bob', 'bob@example.com');
39            INSERT INTO users (name, email) VALUES ('Charlie', 'charlie@example.com');
40            INSERT INTO users (name, email) VALUES ('David', 'david@example.com');
41        ");
42
43        echo "--- PDO::FETCH_OBJ と PDO::FETCH_ORI_REL のデモンストレーション ---" . PHP_EOL;
44
45        // SQLクエリを準備
46        $stmt = $pdo->prepare("SELECT id, name, email FROM users ORDER BY id");
47        $stmt->execute();
48
49        echo "1. 最初の行をオブジェクトとして取得 (fetch(PDO::FETCH_OBJ))" . PHP_EOL;
50        // デフォルトでは PDO::FETCH_ORI_NEXT と同じ挙動で、レコードを取得し、カーソルを次の行に進めます。
51        // この時点でカーソルは 'Alice' の次のレコード、つまり 'Bob' の位置を指しています。
52        $firstUser = $stmt->fetch(PDO::FETCH_OBJ);
53        if ($firstUser) {
54            echo "   取得データ: ID: {$firstUser->id}, Name: {$firstUser->name}, Email: {$firstUser->email}" . PHP_EOL;
55            echo "   (カーソルは現在、'Bob' のレコードを指しています)" . PHP_EOL;
56        } else {
57            echo "   最初のユーザーが見つかりませんでした。" . PHP_EOL;
58        }
59
60        echo PHP_EOL . "2. 現在のカーソル位置から相対的に1つ次の行をオブジェクトとして取得 (fetch(PDO::FETCH_OBJ, PDO::FETCH_ORI_REL, 1))" . PHP_EOL;
61        // カーソルは現在 'Bob' の位置にあるため、PDO::FETCH_ORI_REL, 1 は 'Bob' の次のレコード、
62        // つまり 'Charlie' を取得します。
63        // 取得後、カーソルは 'Charlie' の次のレコード、つまり 'David' の位置に進みます。
64        $relativeUser = $stmt->fetch(PDO::FETCH_OBJ, PDO::FETCH_ORI_REL, 1);
65        if ($relativeUser) {
66            echo "   取得データ: ID: {$relativeUser->id}, Name: {$relativeUser->name}, Email: {$relativeUser->email}" . PHP_EOL;
67            echo "   (カーソルは現在、'David' のレコードを指しています)" . PHP_EOL;
68        } else {
69            echo "   相対的な次のユーザーが見つかりませんでした。" . PHP_EOL;
70        }
71        
72        echo PHP_EOL . "3. カーソルをさらに相対的に移動し、オブジェクトとして取得 (fetch(PDO::FETCH_OBJ, PDO::FETCH_ORI_REL, 1))" . PHP_EOL;
73        // カーソルは現在 'David' の位置にあるため、PDO::FETCH_ORI_REL, 1 は 'David' の次のレコードを
74        // 取得しようとします。データが存在しないため、nullが返されます。
75        $relativeUser2 = $stmt->fetch(PDO::FETCH_OBJ, PDO::FETCH_ORI_REL, 1);
76        if ($relativeUser2) {
77            echo "   取得データ: ID: {$relativeUser2->id}, Name: {$relativeUser2->name}, Email: {$relativeUser2->email}" . PHP_EOL;
78        } else {
79            echo "   相対的な次のユーザーが見つかりませんでした (データなし)。" . PHP_EOL;
80        }
81
82    } catch (PDOException $e) {
83        // データベース接続やクエリ実行に関するエラーをキャッチして表示
84        echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
85    }
86}
87
88// 関数を実行してデモンストレーションを開始
89demonstratePdoFetchRelativeObject();

このPHPサンプルコードは、PDO（PHP Data Objects）を使用し、データベースのレコードをオブジェクトとして相対的に取得する方法を示しています。

PDO::FETCH_ORI_RELはint型の定数で、PDOStatement::fetch()メソッドの$orientation引数に指定することで、現在のカーソル位置から指定オフセット分移動したレコードを取得します。この機能は、PDO接続時にPDO::ATTR_CURSOR => PDO::CURSOR_SCROLLを設定し、スクロール可能なカーソルを有効にすることで利用可能です。

PDO::FETCH_OBJは、データベースから取得した一行のデータを、各カラム名がプロパティ名となるオブジェクトとして返すよう指示する定数です。これにより、$user->nameのように直感的にデータへアクセスできます。

サンプルでは、最初のレコードをfetch(PDO::FETCH_OBJ)で取得後、fetch(PDO::FETCH_OBJ, PDO::FETCH_ORI_REL, 1)で現在のカーソル位置から1つ先のレコードをオブジェクトとして取得しています。これにより、PDO::FETCH_ORI_RELを用いたデータベースへの柔軟な相対アクセスが示されます。

Copy
1<?php
2
3/**
4 * PDO::FETCH_ORI_REL を使用して、相対的なカーソル移動でデータを取得するサンプルコード
5 *
6 * システムエンジニアを目指す初心者向けに、PHPのPDO拡張機能を使ってデータベースからデータを取得し、
7 * カーソルを現在の位置から相対的に移動させる方法を示します。
8 * `fetchone`というキーワードは、PDOStatement::fetch() メソッドが「結果セットから単一の行を取得する」
9 * という意味で使われることが多いです。
10 */
11function demonstratePdoFetchOriRel(): void
12{
13    $db = null; // データベース接続オブジェクトの初期化
14    try {
15        // SQLiteのインメモリデータベースに接続します。
16        // PDO::ATTR_CURSOR => PDO::CURSOR_SCROLL を指定することで、カーソルを結果セット内で
17        // 前後（相対的または絶対的）に移動できるようになります。
18        $db = new PDO('sqlite::memory:', null, null, [
19            PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION, // エラーモードを例外に設定
20            PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC, // デフォルトのフェッチモードを連想配列に設定
21            PDO::ATTR_CURSOR => PDO::CURSOR_SCROLL, // スクロール可能なカーソルを有効にする
22        ]);
23
24        // サンプルテーブルを作成
25        $db->exec("CREATE TABLE IF NOT EXISTS users (
26            id INTEGER PRIMARY KEY AUTOINCREMENT,
27            name TEXT NOT NULL,
28            email TEXT NOT NULL UNIQUE
29        )");
30
31        // サンプルデータを挿入
32        $db->exec("INSERT INTO users (name, email) VALUES ('Alice', 'alice@example.com')");
33        $db->exec("INSERT INTO users (name, email) VALUES ('Bob', 'bob@example.com')");
34        $db->exec("INSERT INTO users (name, email) VALUES ('Charlie', 'charlie@example.com')");
35        $db->exec("INSERT INTO users (name, email) VALUES ('David', 'david@example.com')");
36        $db->exec("INSERT INTO users (name, email) VALUES ('Eve', 'eve@example.com')");
37
38        echo "--- データベース準備完了 ---\n\n";
39
40        // 全てのユーザーを取得するプリペアドステートメントを準備
41        $stmt = $db->prepare("SELECT id, name, email FROM users ORDER BY id");
42        $stmt->execute(); // クエリを実行
43
44        echo "--- カーソル操作開始 ---\n";
45
46        // 1. 最初の行を取得 (デフォルトでは PDO::FETCH_ORI_NEXT が使用され、次の行に進みます)
47        // PDOStatement::fetch() は、結果セットから次の行を単一の配列として返します。
48        $row1 = $stmt->fetch();
49        if ($row1) {
50            echo "1. 最初の行を取得 (ID: {$row1['id']}, Name: {$row1['name']})\n";
51        }
52
53        // 2. 次の行を取得 (再度 PDO::FETCH_ORI_NEXT で、さらに次の行に進みます)
54        $row2 = $stmt->fetch();
55        if ($row2) {
56            echo "2. 次の行を取得 (ID: {$row2['id']}, Name: {$row2['name']})\n";
57        }
58
59        // 3. PDO::FETCH_ORI_REL を使用して、現在のカーソル位置から「相対的に」前の行を取得します。
60        // 現在カーソルはID=2の行にあるため、-1を指定するとID=1の行に戻ります。
61        // PDO::FETCH_ASSOC は結果を連想配列で返すことを指定しています。
62        $row_rel_back = $stmt->fetch(PDO::FETCH_ASSOC, PDO::FETCH_ORI_REL, -1);
63        if ($row_rel_back) {
64            echo "3. 相対的に前の行を取得 (PDO::FETCH_ORI_REL, -1): ID {$row_rel_back['id']}, Name: {$row_rel_back['name']}\n";
65        } else {
66            echo "3. 相対的に前の行を取得できませんでした。\n";
67        }
68
69        // 4. PDO::FETCH_ORI_REL を使用して、現在のカーソル位置から「相対的に」2つ後の行を取得します。
70        // 現在カーソルはID=1の行にあるため、2を指定するとID=3の行に進みます。
71        $row_rel_forward = $stmt->fetch(PDO::FETCH_ASSOC, PDO::FETCH_ORI_REL, 2);
72        if ($row_rel_forward) {
73            echo "4. 相対的に2つ後の行を取得 (PDO::FETCH_ORI_REL, 2): ID {$row_rel_forward['id']}, Name: {$row_rel_forward['name']}\n";
74        } else {
75            echo "4. 相対的に2つ後の行を取得できませんでした。\n";
76        }
77
78        echo "--- カーソル操作終了 ---\n";
79
80    } catch (PDOException $e) {
81        // データベース関連のエラーが発生した場合の処理
82        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
83    } catch (Exception $e) {
84        // その他の予期せぬエラーが発生した場合の処理
85        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
86    } finally {
87        // データベース接続は通常、スクリプト終了時に自動的に閉じられますが、
88        // 明示的に接続を解除する場合は $db = null; とします。
89        $db = null;
90    }
91}
92
93// 関数を実行してサンプルコードの動作を確認します
94demonstratePdoFetchOriRel();

PDO::FETCH_ORI_RELは、PHPのデータベース操作拡張機能であるPDOで使用される定数の一つです。この定数は、PDOStatement::fetch()メソッドに渡すことで、データベースの結果セットにおけるカーソルの移動方法を「現在の位置から相対的に」指定するために利用されます。定数自体は整数値を持ち、PDOStatement::fetch()メソッドの第2引数として使用されます。

PDOStatement::fetch()メソッドは、結果セットから単一の行を取得する際に、PDO::FETCH_ORI_RELと共に第3引数で移動するオフセット（距離）を整数値で受け取ります。例えば、-1を指定すると現在の位置から一つ前の行へ、2を指定すると二つ先の行へカーソルを移動させ、その行のデータを取得します。この機能を使用するには、PDO接続時にPDO::ATTR_CURSOR属性をPDO::CURSOR_SCROLLに設定し、スクロール可能なカーソルを有効にする必要があります。これにより、結果セット内を自由に行き来してデータを取り出すことが可能になります。PDOStatement::fetch()メソッドは、指定されたカーソル位置の行データを通常、配列形式で返します。