【PHP8.x】Pdo\Sqlite::ATTR_DEFAULT_FETCH_MODE定数の使い方

Copy
1<?php
2
3/**
4 * PDO::ATTR_DEFAULT_FETCH_MODE の使用例を示します。
5 *
6 * この属性は、PDOStatement::fetch() や PDOStatement::fetchAll() メソッドで
7 * フェッチモードを明示的に指定しない場合の、デフォルトのデータ取得方法を設定します。
8 * システムエンジニアを目指す初心者向けに、SQLiteインメモリデータベースを用いた
9 * 単体で動作可能なサンプルコードです。
10 */
11function demonstratePdoDefaultFetchMode(): void
12{
13    // SQLiteのインメモリデータベースを使用し、ファイル作成を避ける
14    $dsn = 'sqlite::memory:';
15
16    try {
17        // PDOインスタンスを作成し、初期設定としてデフォルトフェッチモードを設定
18        $pdo = new PDO($dsn, null, null, [
19            PDO::ATTR_ERRMODE            => PDO::ERRMODE_EXCEPTION, // エラーモードを例外に設定
20            PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,       // デフォルトのフェッチモードを連想配列に設定
21        ]);
22
23        echo "データベースに接続しました。\n";
24
25        // テーブルを作成
26        $pdo->exec("CREATE TABLE IF NOT EXISTS users (
27            id INTEGER PRIMARY KEY AUTOINCREMENT,
28            name TEXT NOT NULL
29            );");
30        echo "テーブル 'users' を作成しました。\n";
31
32        // データを挿入
33        $pdo->exec("INSERT INTO users (name) VALUES ('Alice');");
34        $pdo->exec("INSERT INTO users (name) VALUES ('Bob');");
35        echo "データを挿入しました。\n";
36
37        // デフォルトフェッチモード (PDO::FETCH_ASSOC) でデータを取得
38        echo "\n--- デフォルトフェッチモード (PDO::FETCH_ASSOC) で取得した結果 ---\n";
39        $stmt = $pdo->query("SELECT id, name FROM users;");
40        $usersAssoc = $stmt->fetchAll();
41
42        foreach ($usersAssoc as $user) {
43            echo "ID: " . $user['id'] . ", Name: " . $user['name'] . "\n";
44        }
45
46        // PDO::setAttribute() を使用して、デフォルトフェッチモードを PDO::FETCH_OBJ に変更
47        $pdo->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_OBJ);
48        echo "\nデフォルトフェッチモードを PDO::FETCH_OBJ に変更しました。\n";
49
50        // 新しいデフォルトフェッチモード (PDO::FETCH_OBJ) でデータを取得
51        echo "\n--- デフォルトフェッチモード (PDO::FETCH_OBJ) で取得した結果 ---\n";
52        $stmt = $pdo->query("SELECT id, name FROM users;");
53        $usersObj = $stmt->fetchAll();
54
55        foreach ($usersObj as $user) {
56            echo "ID: " . $user->id . ", Name: " . $user->name . "\n";
57        }
58
59    } catch (PDOException $e) {
60        // データベース関連のエラーが発生した場合
61        echo "データベースエラー: " . $e->getMessage() . "\n";
62    } finally {
63        // PDOオブジェクトをnullにすることでデータベース接続を閉じる
64        $pdo = null;
65        echo "\nデータベース接続を閉じました。\n";
66    }
67}
68
69// 関数を実行してサンプルコードの動作を示す
70demonstratePdoDefaultFetchMode();
71

PDO::ATTR_DEFAULT_FETCH_MODEは、PHPのPDOライブラリでデータベースからデータを取得する際の、デフォルトの形式（フェッチモード）を指定するための定数です。この定数にPDO::FETCH_ASSOC（連想配列）やPDO::FETCH_OBJ（匿名オブジェクト）といった値を設定することで、PDOStatement::fetch()やPDOStatement::fetchAll()メソッドにおいて、フェッチモードを明示的に指定しなかった場合のデータの取得形式を決定します。設定は、PDOオブジェクトの生成時にオプションとして渡すか、またはPDO::setAttribute()メソッドを用いて実行中に変更することが可能です。この定数自体の戻り値はint型で、これは各フェッチモードが内部で整数値として扱われていることを示します。

サンプルコードでは、手軽に試せるSQLiteのインメモリデータベースに接続しています。まず、PDOインスタンスの初期化時にPDO::ATTR_DEFAULT_FETCH_MODEをPDO::FETCH_ASSOCに設定し、データベースからデータを取得すると、結果が連想配列として返される様子を示しています。その後、PDO::setAttribute()を使ってデフォルトフェッチモードをPDO::FETCH_OBJに変更し、再度データを取得しています。これにより、今度は結果が匿名オブジェクトとして返されることを実演しており、デフォルトのフェッチモードがデータの取得形式にどのように影響するかを明確に理解できます。この機能は、コード全体でデータ取得の一貫性を保つ上で役立ちます。