【PHP8.x】PDOStatement::bindColumn()メソッドの使い方

Copy
1<?php
2
3/**
4 * PDOStatement::bindColumn の使い方をデモンストレーションする関数。
5 * データベースからデータを取得し、PHP変数にカラムをバインドします。
6 */
7function demonstratePdoBindColumn(): void
8{
9    // SQLite のインメモリデータベースに接続
10    // 本番環境では適切なデータベース接続情報を使用してください
11    try {
12        $pdo = new PDO('sqlite::memory:');
13        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
14        $pdo->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_ASSOC);
15
16        // テスト用のテーブルを作成
17        $pdo->exec("
18            CREATE TABLE users (
19                id INTEGER PRIMARY KEY AUTOINCREMENT,
20                name TEXT NOT NULL,
21                email TEXT NOT NULL
22            );
23        ");
24
25        // テストデータを挿入
26        $stmt = $pdo->prepare("INSERT INTO users (name, email) VALUES (:name, :email)");
27        $stmt->execute([':name' => 'Alice', ':email' => 'alice@example.com']);
28        $stmt->execute([':name' => 'Bob', ':email' => 'bob@example.com']);
29        $stmt->execute([':name' => 'Charlie', ':email' => 'charlie@example.com']);
30
31        echo "--- データの挿入が完了しました ---\n\n";
32
33        // SELECT ステートメントを準備
34        $stmt = $pdo->prepare("SELECT id, name, email FROM users");
35
36        // カラムにバインドする変数を宣言
37        $userId = null;
38        $userName = null;
39        $userEmail = null;
40
41        // PDOStatement::bindColumn を使用して、結果セットのカラムをPHP変数にバインド
42        // 第1引数: カラム名 (string) または 1から始まるインデックス (int)
43        // 第2引数: バインドするPHP変数 (参照渡し)
44        // 第3引数: データ型 (PDO::PARAM_STR, PDO::PARAM_INT など)。省略するとPDO::PARAM_STR
45        $stmt->bindColumn('id', $userId, PDO::PARAM_INT); // idカラムを整数として$userIdにバインド
46        $stmt->bindColumn('name', $userName);           // nameカラムを文字列として$userNameにバインド (デフォルト)
47        $stmt->bindColumn(3, $userEmail);               // 3番目のカラム (email) を$userEmailにバインド
48
49        // ステートメントを実行
50        $stmt->execute();
51
52        echo "--- bindColumn を使用してデータをフェッチ中 ---\n";
53
54        // PDO::FETCH_BOUND を指定して結果をフェッチすると、
55        // bindColumn でバインドされた変数に自動的に値がセットされます
56        while ($stmt->fetch(PDO::FETCH_BOUND)) {
57            echo "ID: " . $userId . ", 名前: " . $userName . ", メール: " . $userEmail . "\n";
58        }
59
60        echo "\n--- 全データのフェッチが完了しました ---\n";
61
62    } catch (PDOException $e) {
63        echo "データベースエラー: " . $e->getMessage() . "\n";
64    }
65}
66
67// 関数の実行
68demonstratePdoBindColumn();

PHPのPDOStatement::bindColumnメソッドは、データベースからクエリを実行し、結果のデータを取得する際に、その各カラムの値を特定のPHP変数に直接関連付けるためのメソッドです。これにより、フェッチのたびに配列やオブジェクトから値を取り出す手間を省き、コードを簡潔に保つことができます。

このメソッドは、第一引数$columnにバインドしたいカラムの名前を文字列で、または1から始まるカラムの順序を整数で指定します。第二引数&$varには、データベースのカラムと関連付けたいPHP変数を指定します。この変数は参照渡しであるため、結果がフェッチされるたびに自動的に最新の値に更新されます。第三引数$typeはオプションで、バインドするデータの型（例えば文字列ならPDO::PARAM_STR、整数ならPDO::PARAM_INT）を指定できます。省略した場合はPDO::PARAM_STRとして扱われます。メソッドはバインドが成功すればtrue、失敗すればfalseを返します。

サンプルコードでは、SELECT文で取得したid、name、emailカラムを、それぞれ$userId、$userName、$userEmailというPHP変数にbindColumnで関連付けています。idにはPDO::PARAM_INT型を指定し、nameとemailはデフォルトまたはインデックスでバインドしています。そして$stmt->fetch(PDO::FETCH_BOUND)を実行するたびに、データベースから取得されたデータがこれらのバインドされた変数に自動的にセットされ、個別の変数として簡単に利用できる様子が示されています。