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

Copy
1<?php
2
3/**
4 * PDO::FETCH_NAMED を使用してデータベースからデータを取得するサンプル関数。
5 *
6 * PDO::FETCH_NAMED は、結果セットの各行をカラム名をキーとする連想配列として返します。
7 * 同じカラム名が複数存在する場合、それらの値はキーに対応する配列内に格納されます。
8 * (例: SELECT col1, col2, col1 FROM table; の結果は ['col1' => [value1, value3], 'col2' => value2] のようになる)
9 * 通常、カラム名が一意であるSQLクエリでは、PDO::FETCH_ASSOC と同様の結果になります。
10 */
11function fetchAllWithPdoFetchNamed(): void
12{
13    // SQLiteのインメモリデータベースに接続。
14    // 実際のアプリケーションでは、ファイルパスや接続情報を指定します。
15    $dsn = 'sqlite::memory:';
16
17    try {
18        // PDOオブジェクトを生成し、データベースに接続。
19        // エラーモードをPDO::ERRMODE_EXCEPTIONに設定することで、
20        // データベース操作中のエラーをPDOExceptionとして捕捉できるようになります。
21        $pdo = new PDO($dsn);
22        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
23
24        echo "データベースに接続しました。\n\n";
25
26        // サンプル用の 'products' テーブルを作成。
27        $pdo->exec("
28            CREATE TABLE IF NOT EXISTS products (
29                id INTEGER PRIMARY KEY AUTOINCREMENT,
30                name TEXT NOT NULL,
31                price REAL NOT NULL,
32                category TEXT NOT NULL
33            );
34        ");
35        echo "テーブル 'products' を作成しました。\n\n";
36
37        // サンプルデータを挿入。
38        $pdo->exec("INSERT INTO products (name, price, category) VALUES ('Laptop', 1200.00, 'Electronics');");
39        $pdo->exec("INSERT INTO products (name, price, category) VALUES ('Mouse', 25.00, 'Electronics');");
40        $pdo->exec("INSERT INTO products (name, price, category) VALUES ('Keyboard', 75.00, 'Electronics');");
41        $pdo->exec("INSERT INTO products (name, price, category) VALUES ('Desk Chair', 150.00, 'Furniture');");
42        echo "サンプルデータを挿入しました。\n\n";
43
44        // 全ての製品データを取得するSQLクエリを準備。
45        // ここでは、カラム名が重複しない一般的なクエリを使用します。
46        // 重複するカラム名（例: SELECT name, price, name FROM products）を使用した場合は、
47        // 'name' キーの値が配列（['Laptop', 'Laptop_duplicate']）になります。
48        $stmt = $pdo->prepare("SELECT id, name, price, category FROM products");
49        $stmt->execute();
50
51        // PDO::FETCH_NAMED オプションを指定して、全ての行をフェッチ。
52        // 各行は、カラム名をキーとする連想配列として返されます。
53        $results = $stmt->fetchAll(PDO::FETCH_NAMED);
54
55        echo "--- PDO::FETCH_NAMED で取得したデータ --- \n";
56        print_r($results);
57
58    } catch (PDOException $e) {
59        // データベース関連のエラーが発生した場合、そのメッセージを表示。
60        echo "データベースエラー: " . $e->getMessage() . "\n";
61    } catch (Exception $e) {
62        // PDOException以外の一般的なエラーが発生した場合、そのメッセージを表示。
63        echo "一般的なエラー: " . $e->getMessage() . "\n";
64    }
65}
66
67// 関数を実行
68fetchAllWithPdoFetchNamed();

PDO::FETCH_NAMEDは、PHPのデータベースアクセス拡張であるPDO（PHP Data Objects）において、データベースからデータを取得する際の形式を指定する定数です。この定数をPDOStatement::fetchAll()などのメソッドに指定すると、結果セットの各行が、カラム名をキーとする連想配列として返されます。

この定数の最大の特徴は、もしSQLクエリで同じカラム名が複数回選択された場合にあります。その際、それぞれの値は一つのカラム名キーに対応する配列として格納されます。例えば、SELECT col1, col2, col1 FROM tableのようなクエリの結果は、['col1' => [value1, value3], 'col2' => value2]のように整理されます。カラム名が重複しない一般的なクエリでは、PDO::FETCH_ASSOCと同様に、カラム名をキー、その行の値を対応するデータとする連想配列が返されます。

サンプルコードでは、SQLiteのインメモリデータベースに接続し、productsテーブルを作成後、いくつかサンプルデータを挿入しています。その後、SELECT id, name, price, category FROM productsというSQLクエリを実行し、fetchAll(PDO::FETCH_NAMED)を使用して全てのデータを取得しています。これにより、各製品の情報がid, name, price, categoryといったカラム名をキーとした連想配列の形式で取得され、その結果が出力されます。この定数を使うことで、重複するカラム名を持つデータも適切に扱えるようになります。

Copy
1<?php
2
3/**
4 * システムエンジニアを目指す初心者向けに、PDO::FETCH_NAMED 定数の使用例を示します。
5 * この定数は、MySQLiのfetch_assoc()のように連想配列で結果を取得する際に、
6 * SQLクエリで同じカラム名が複数回現れる場合の特殊な挙動を制御します。
7 */
8function demonstratePdoFetchNamed(): void
9{
10    // SQLiteのインメモリデータベースに接続します。
11    // ファイルを必要としないため、環境構築なしで簡単にテストできます。
12    try {
13        $pdo = new PDO('sqlite::memory:');
14        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
15
16        // サンプルテーブルとデータの作成
17        $pdo->exec("
18            CREATE TABLE users (
19                id INTEGER PRIMARY KEY,
20                name TEXT NOT NULL
21            );
22            INSERT INTO users (id, name) VALUES (1, 'Alice');
23        ");
24
25        // カラム名が意図的に重複するSQLクエリを実行します。
26        // ここでは 'id' カラムが2回選択されています。
27        $stmt = $pdo->query("SELECT id, name, id FROM users WHERE id = 1");
28
29        // PDO::FETCH_NAMED を使用して結果を取得します。
30        // MySQLiのfetch_assoc()と同様にカラム名をキーとして使用しますが、
31        // SQLクエリで重複するカラム名がある場合、そのキーの値は配列として格納されます。
32        $result = $stmt->fetch(PDO::FETCH_NAMED);
33
34        // 取得した結果を表示します。
35        print_r($result);
36
37        // 上記の出力結果では、'id' キーが配列になっており、
38        // SQLクエリで選択された2つの 'id' カラムの値がその配列にまとめられていることが確認できます。
39        // 通常の PDO::FETCH_ASSOC や MySQLi の fetch_assoc() では、
40        // 同じカラム名の場合、後から取得した値で上書きされてしまいますが、
41        // PDO::FETCH_NAMED は重複する名前の値を全て保持します。
42
43    } catch (PDOException $e) {
44        // データベース接続やクエリ実行でエラーが発生した場合にメッセージを表示します。
45        echo "データベースエラー: " . $e->getMessage() . "\n";
46    }
47}
48
49// 関数を実行して、PDO::FETCH_NAMED の動作を確認します。
50demonstratePdoFetchNamed();

PDO::FETCH_NAMEDは、PHPのPDO拡張機能でデータベースから結果を取得する際の「フェッチモード」を指定する定数の一つです。これは、PDOStatement::fetch()メソッドに引数として渡すことで、結果を連想配列形式で取得する際の特別な挙動を定義します。

この定数の主な特徴は、SQLクエリで同じカラム名が複数回選択された場合に、その値をどのように扱うかという点にあります。一般的なmysqli::fetch_assoc()やPDO::FETCH_ASSOCでは、重複するカラム名があった場合、後から取得した値で上書きされてしまいます。しかし、PDO::FETCH_NAMEDを使用すると、重複する名前のカラムの値は自動的に配列としてまとめられ、すべての値が失われることなく保持されます。

サンプルコードでは、SELECT id, name, id FROM usersのようにidカラムを意図的に重複させています。$stmt->fetch(PDO::FETCH_NAMED)を実行すると、結果の連想配列において'id'キーの値が配列となり、SQLクエリで選択された二つのidの値（この場合は両方とも1）がその配列の中に格納されていることが確認できます。これにより、意図せず値が上書きされることなく、すべての重複する値を取得できます。

PDO::FETCH_NAMED定数自体は引数を持ちません。その戻り値は内部的な整数値であり、PDOStatement::fetch()メソッドに渡すことで、結果セットの取得形式を制御する役割を果たします。