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

Copy
1<?php
2
3/**
4 * データベースからフェッチしたデータを格納するためのシンプルなクラス。
5 * PDO::FETCH_INTO スタイルを使用すると、このクラスのインスタンスに直接データがマッピングされます。
6 */
7class UserData
8{
9    public int $id;
10    public string $name;
11    public int $age;
12
13    /**
14     * オブジェクトが生成されたことを示すコンストラクタ。
15     * データベースからフェッチする前に、このオブジェクトがすでに存在していることを示します。
16     */
17    public function __construct()
18    {
19        echo "UserDataオブジェクトが初期化されました。\n";
20    }
21}
22
23/**
24 * PDO::FETCH_INTO を使用して、データベースの行を既存のオブジェクトにフェッチするサンプル関数です。
25 * システムエンジニアを目指す初心者の方にも分かりやすいように、SQLiteのインメモリデータベースを使用しています。
26 * これにより、追加のデータベース設定なしでPHPコードを実行できます。
27 */
28function demonstratePdoFetchInto(): void
29{
30    // SQLiteのインメモリデータベースに接続します。
31    // 実際のアプリケーションでは、MySQLやPostgreSQLなどのデータベース接続情報に置き換えてください。
32    $dsn = 'sqlite::memory:'; // メモリ上に一時的なデータベースを作成
33    $username = null;        // SQLiteではユーザー名は不要
34    $password = null;        // SQLiteではパスワードは不要
35
36    try {
37        // PDO (PHP Data Objects) を使用してデータベースに接続します。
38        // PDO::ATTR_ERRMODE を PDO::ERRMODE_EXCEPTION に設定することで、
39        // データベースのエラーが発生した際に例外がスローされ、try-catchブロックで処理できます。
40        $pdo = new PDO($dsn, $username, $password, [
41            PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
42            PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC // デフォルトのフェッチモードを設定 (ここではFETCH_INTOが優先される)
43        ]);
44
45        echo "データベース接続に成功しました。\n";
46
47        // サンプルテーブルを作成し、データを挿入します。
48        $pdo->exec("CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY, name TEXT, age INTEGER)");
49        $pdo->exec("INSERT INTO users (name, age) VALUES ('田中 太郎', 30)");
50        $pdo->exec("INSERT INTO users (name, age) VALUES ('鈴木 花子', 25)");
51        echo "サンプルテーブルとデータの準備が完了しました。\n";
52
53        // データベースからフェッチしたデータを格納するための、既存のUserDataオブジェクトをインスタンス化します。
54        // PDO::FETCH_INTOは、新しいオブジェクトを生成するのではなく、この既存のオブジェクトにデータをマッピングします。
55        $existingUser = new UserData();
56        echo "データをフェッチするための既存のUserDataオブジェクトを準備しました。\n";
57
58        // ユーザー '田中 太郎' のデータを取得するSQLクエリを準備します。
59        $stmt = $pdo->prepare("SELECT id, name, age FROM users WHERE name = :name");
60        $stmt->execute([':name' => '田中 太郎']);
61
62        // PDO::FETCH_INTO スタイルを使用して、クエリ結果を既存の $existingUser オブジェクトにフェッチします。
63        // データベースのカラム名 (id, name, age) とオブジェクトのプロパティ名 (id, name, age) が一致している場合、
64        // PDOは自動的に対応するプロパティに値を割り当てます。
65        if ($stmt->fetch(PDO::FETCH_INTO, $existingUser)) {
66            echo "\nPDO::FETCH_INTO を使用して、既存のオブジェクトにデータをフェッチしました。\n";
67            echo "--- フェッチされたデータ --- \n";
68            echo "ID: " . $existingUser->id . "\n";
69            echo "名前: " . $existingUser->name . "\n";
70            echo "年齢: " . $existingUser->age . "\n";
71        } else {
72            echo "\n指定されたユーザーのデータをフェッチできませんでした。\n";
73        }
74
75        // 別のクエリで、同じ既存のオブジェクトを再利用してデータをフェッチすることも可能です。
76        // この場合、既存オブジェクトのプロパティは新しいデータで上書きされます。
77        $stmt2 = $pdo->prepare("SELECT id, name, age FROM users WHERE name = :name");
78        $stmt2->execute([':name' => '鈴木 花子']);
79
80        if ($stmt2->fetch(PDO::FETCH_INTO, $existingUser)) {
81            echo "\n既存のUserDataオブジェクトに、再度別のユーザー (鈴木 花子) のデータをフェッチしました。\n";
82            echo "--- 再度フェッチされたデータ --- \n";
83            echo "ID: " . $existingUser->id . "\n";
84            echo "名前: " . $existingUser->name . "\n";
85            echo "年齢: " . $existingUser->age . "\n";
86        } else {
87            echo "\n鈴木 花子のデータをフェッチできませんでした。\n";
88        }
89
90    } catch (PDOException $e) {
91        // データベース関連のエラーが発生した場合に、エラーメッセージを表示します。
92        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
93    } catch (Exception $e) {
94        // その他の予期せぬエラーが発生した場合に、エラーメッセージを表示します。
95        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
96    } finally {
97        // 接続を閉じる (PHPではスクリプト終了時に自動的に閉じられることが多いですが、明示的にnullを代入することもできます)
98        $pdo = null;
99        echo "\nデータベース接続を閉じました。\n";
100    }
101}
102
103// サンプル関数を実行します。
104demonstratePdoFetchInto();
105
106?>

PHPのPDO::FETCH_INTOは、データベースから取得した行データを、事前に作成された既存のPHPオブジェクトに直接マッピングするための定数です。この定数をPDOStatement::fetch()メソッドの引数として指定することで、データベースのカラム名と一致するプロパティを持つオブジェクトに対し、取得した値を自動的に割り当てることができます。PDO::FETCH_INTOは、PDO::FETCH_OBJが新しいオブジェクトを生成するのに対し、既存のオブジェクトを再利用する点が特徴です。これにより、オブジェクトの初期化や再利用の柔軟性が向上します。この定数自体に引数や戻り値はありませんが、PDOStatement::fetch()メソッドの挙動を制御する重要なモードとして機能します。

提供されたサンプルコードでは、UserDataクラスのインスタンスを事前に作成し、demonstratePdoFetchInto関数内でこの既存の$existingUserオブジェクトに対し、SQLiteのインメモリデータベースから取得したid、name、ageのデータをフェッチしています。データベースのカラム名とUserDataクラスのプロパティ名が一致しているため、fetch(PDO::FETCH_INTO, $existingUser)を呼び出すだけで、オブジェクトのプロパティが自動的に更新される様子を確認できます。同じオブジェクトを再利用して異なるデータをフェッチし、プロパティが上書きされる挙動も示されており、データベースから取得したデータを既存の構造に効率的に組み込む方法を学べます。