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

Copy
1<?php
2
3/**
4 * このサンプルコードは、PHPのPDO拡張機能におけるPDO::FETCH_INTO定数の使用方法を示します。
5 * PDO::FETCH_INTOは、データベースの行データを既存のオブジェクトのプロパティにマッピングするために使用されます。
6 * これは、ODBCのodbc_fetch_into関数が既存の変数にデータをフェッチするのと概念的に似ています。
7 *
8 * リファレンス情報にある「所属クラス: Pdo\Sqlite」は、PHP 8で利用可能なSQLiteドライバを指す意図と推測されますが、
9 * FETCH_INTO定数自体はPdo名前空間ではなく、グローバルなPDOクラスの定数として `PDO::FETCH_INTO` の形で利用されます。
10 * この定数の戻り値は `int` 型です。
11 */
12
13/**
14 * データベースからフェッチされるデータを保持するためのシンプルなクラス。
15 */
16class User
17{
18    public int $id = 0;
19    public string $name = '';
20    public string $email = '';
21
22    /**
23     * ユーザー情報を表示するメソッド。
24     */
25    public function display(): void
26    {
27        echo "ID: {$this->id}, Name: {$this->name}, Email: {$this->email}\n";
28    }
29}
30
31/**
32 * PDO::FETCH_INTO を使用してデータベースからデータをフェッチする例を実演します。
33 */
34function demonstratePdoFetchInto(): void
35{
36    $dbPath = ':memory:'; // インメモリSQLiteデータベースを使用
37
38    try {
39        // 1. SQLiteデータベースに接続
40        $pdo = new PDO("sqlite:{$dbPath}");
41        // エラーモードを例外に設定し、エラー発生時にPDOExceptionをスローさせる
42        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
43        echo "データベースに接続しました。\n";
44
45        // 2. テーブルの作成
46        $pdo->exec("
47            CREATE TABLE IF NOT EXISTS users (
48                id INTEGER PRIMARY KEY AUTOINCREMENT,
49                name TEXT NOT NULL,
50                email TEXT UNIQUE NOT NULL
51            );
52        ");
53        echo "usersテーブルを作成しました。\n";
54
55        // 3. サンプルデータの挿入
56        $stmt = $pdo->prepare("INSERT INTO users (name, email) VALUES (?, ?)");
57        $stmt->execute(['Alice Smith', 'alice.smith@example.com']);
58        $stmt->execute(['Bob Johnson', 'bob.johnson@example.com']);
59        echo "サンプルデータを挿入しました。\n";
60
61        // 4. PDO::FETCH_INTO を使用してデータを既存のオブジェクトにフェッチ
62        echo "\n--- PDO::FETCH_INTO を使用したデータフェッチの例 ---\n";
63
64        // 最初の行をフェッチするためのステートメントを準備
65        $stmt1 = $pdo->query("SELECT id, name, email FROM users WHERE id = 1");
66
67        // 既存のUserオブジェクトを作成し、初期値を表示
68        $userObj1 = new User();
69        echo "フェッチ前の userObj1: ";
70        $userObj1->display();
71
72        // データを userObj1 オブジェクトにフェッチ
73        // PDO::FETCH_INTO の定数（int型）は、フェッチモードとして指定され、
74        // その後に既存のオブジェクトが渡されます。
75        $stmt1->fetch(PDO::FETCH_INTO, $userObj1);
76
77        echo "フェッチ後の userObj1: ";
78        $userObj1->display(); // オブジェクトのプロパティがデータベースの値で更新されている
79
80        echo "\n";
81
82        // 2番目の行をフェッチするためのステートメントを準備
83        $stmt2 = $pdo->query("SELECT id, name, email FROM users WHERE id = 2");
84
85        // 別の既存のUserオブジェクトを作成し、初期値を表示
86        $userObj2 = new User();
87        echo "フェッチ前の userObj2: ";
88        $userObj2->display();
89
90        // データを userObj2 オブジェクトにフェッチ
91        $stmt2->fetch(PDO::FETCH_INTO, $userObj2);
92
93        echo "フェッチ後の userObj2: ";
94        $userObj2->display(); // オブジェクトのプロパティがデータベースの値で更新されている
95
96    } catch (PDOException $e) {
97        // データベース関連のエラーをキャッチ
98        echo "データベースエラー: " . $e->getMessage() . "\n";
99    } catch (Exception $e) {
100        // その他のエラーをキャッチ
101        echo "一般エラー: " . $e->getMessage() . "\n";
102    } finally {
103        // PDOオブジェクトはスクリプト終了時に自動的にクローズされますが、明示的にnullを設定することも可能です。
104        $pdo = null;
105        echo "\nデータベース接続をクローズしました。\n";
106    }
107}
108
109// サンプルコードを実行
110demonstratePdoFetchInto();

PHPのPDO::FETCH_INTOは、データベースから取得した行データを、すでに存在するオブジェクトのプロパティへ直接マッピングするために使用される定数です。この定数自体は引数を持たず、int型の整数値を返します。これは、PDOStatement::fetch()メソッドに渡すことで、データをどのように取得するかを指定する「フェッチモード」として機能します。

具体的には、fetch(PDO::FETCH_INTO, $existingObject)のように、この定数とデータを格納したい既存のオブジェクトを一緒に指定します。これにより、データベースの列名と一致するプロパティを持つ既存のオブジェクトが、その行の値で更新されます。新しいオブジェクトを都度作成する手間を省き、既存のオブジェクトの状態を効率的に更新できます。

似たような機能として、ODBC拡張機能のodbc_fetch_into関数がありますが、これも同様に既存の変数にデータベースのデータを格納する用途で使われます。PDO::FETCH_INTOもこの概念と似ており、データベースから取得した情報を既存のデータ構造へ流し込む際に役立ちます。

提供されたリファレンス情報では「所属クラス: Pdo\Sqlite」とありますが、PDO::FETCH_INTO定数自体はPdo\Sqliteドライバに限定されず、PHPのPDOクラス全体で利用できるグローバルな定数として、どのデータベースドライバとでも組み合わせて使用できます。この機能は、特にアプリケーション内で一度作成されたオブジェクトを再利用して、データベースのデータで更新したい場合に非常に便利です。