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

Copy
1<?php
2
3/**
4 * PDO::ATTR_DEFAULT_FETCH_MODE を使用して、PDO接続のデフォルトデータ取得モードを設定する例です。
5 *
6 * この定数は、PDOStatement::fetch() メソッドを引数なしで呼び出した際に、
7 * 結果セットの行をどのような形式で返すかを指定します。
8 * 一度設定すると、明示的にフェッチモードを指定しない限り、そのPDO接続オブジェクトに対する
9 * すべての fetch() や fetchAll() 呼び出しに適用されます。
10 */
11function demonstratePdoDefaultFetchMode(): void
12{
13    try {
14        // 単体で動作可能なコードとするため、インメモリSQLiteデータベースに接続します。
15        // これにより、ファイルシステムに影響を与えることなくテストが可能です。
16        $pdo = new PDO('sqlite::memory:', null, null, [
17            // エラーが発生した際にPDOExceptionをスローするように設定します。
18            // これは本番環境でも推奨される設定です。
19            PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION
20        ]);
21
22        // テスト用のテーブルを作成し、サンプルデータを挿入します。
23        $pdo->exec("CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT, age INTEGER)");
24        $pdo->exec("INSERT INTO users (name, age) VALUES ('Alice', 30)");
25        $pdo->exec("INSERT INTO users (name, age) VALUES ('Bob', 25)");
26
27        echo "--- デフォルトフェッチモード未設定時 (PDO::FETCH_BOTH が一般的) ---\n";
28        $stmt = $pdo->query("SELECT * FROM users WHERE name = 'Alice'");
29        // fetch() を引数なしで呼び出すと、現在のデフォルトモードでデータを取得します。
30        $result = $stmt->fetch();
31        print_r($result);
32        echo "\n";
33
34        // --- PDO::ATTR_DEFAULT_FETCH_MODE を PDO::FETCH_ASSOC に設定 ---
35        // この設定により、以後の fetch() 呼び出しは結果を連想配列として返します。
36        $pdo->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_ASSOC);
37        echo "--- PDO::ATTR_DEFAULT_FETCH_MODE を PDO::FETCH_ASSOC に設定後 ---\n";
38        echo "(結果は連想配列として取得されます)\n";
39
40        $stmt = $pdo->query("SELECT * FROM users WHERE name = 'Alice'");
41        $result = $stmt->fetch();
42        print_r($result);
43        echo "\n";
44
45        // --- PDO::ATTR_DEFAULT_FETCH_MODE を PDO::FETCH_OBJ に設定 ---
46        // この設定により、以後の fetch() 呼び出しは結果を匿名オブジェクトとして返します。
47        $pdo->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_OBJ);
48        echo "--- PDO::ATTR_DEFAULT_FETCH_MODE を PDO::FETCH_OBJ に設定後 ---\n";
49        echo "(結果は匿名オブジェクトとして取得されます)\n";
50
51        $stmt = $pdo->query("SELECT * FROM users WHERE name = 'Bob'");
52        $result = $stmt->fetch();
53        print_r($result);
54        // オブジェクトとして取得されたデータには、プロパティでアクセスできます。
55        echo "アクセス例: 名前: " . $result->name . ", 年齢: " . $result->age . "\n";
56        echo "\n";
57
58    } catch (PDOException $e) {
59        // データベース接続やクエリ実行中に発生したPDOExceptionを捕捉し、エラーメッセージを表示します。
60        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
61    }
62}
63
64// 定義した関数を実行します。
65demonstratePdoDefaultFetchMode();

PHPのPDO::ATTR_DEFAULT_FETCH_MODEは、PDO接続を通じてデータベースからデータを取得する際の、デフォルトの形式を指定するための定数です。この定数自体に引数や戻り値はありませんが、PDOオブジェクトのsetAttributeメソッドに設定することで、PDOStatement::fetch()やfetchAll()メソッドの挙動に影響を与えます。

具体的には、一度この定数で取得モードを設定すると、そのPDO接続を通じて実行されるすべてのデータ取得処理で、明示的にフェッチモードを指定しない限り、設定した形式で結果が返されるようになります。

サンプルコードでは、最初にデフォルトの取得モード（通常は数値添字と連想配列の両方を含むPDO::FETCH_BOTH）での取得例を示しています。次に、PDO::setAttributeメソッドを使ってPDO::ATTR_DEFAULT_FETCH_MODEをPDO::FETCH_ASSOCに設定することで、以降のfetch()呼び出しで結果が連想配列として返されることを示します。さらにPDO::FETCH_OBJに設定すると、結果が匿名オブジェクトとして返され、プロパティでデータにアクセスできるようになります。このように、アプリケーション全体でデータ取得形式の統一を図り、コードの記述を効率化するために利用されます。