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

Copy
1<?php
2
3/**
4 * PDO::FETCH_GROUP 定数を使用して、データベースの結果をグループ化してフェッチするサンプルコードです。
5 *
6 * この関数は、システムエンジニアを目指す初心者向けに、PDO (PHP Data Objects) の基本的な使い方と
7 * FETCH_GROUP の挙動を理解しやすいように設計されています。
8 * SQLite インメモリデータベースを使用し、メモリ上で一時的にテーブルを作成し、
9 * サンプルデータを挿入した後にデータをグループ化して取得する一連の流れを示します。
10 */
11function demonstratePdoFetchGroup(): void
12{
13    // データベース操作中のエラーを捕捉するための try-catch ブロック
14    try {
15        // SQLite インメモリデータベースに接続します。
16        // ':memory:' は、データがメモリ上にのみ存在し、スクリプト終了時に消滅することを示します。
17        $pdo = new PDO('sqlite::memory:');
18
19        // エラーモードを設定します。
20        // PDO::ATTR_ERRMODE を PDO::ERRMODE_EXCEPTION に設定することで、
21        // SQLエラーが発生した場合に PDOException がスローされ、catch ブロックで捕捉できるようになります。
22        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
23
24        echo "データベースに接続しました。\n\n";
25
26        // サンプルデータ用の 'products' テーブルを作成します。
27        // PRIMARY KEY AUTOINCREMENT は、id 列が自動的に増分される主キーであることを意味します。
28        $pdo->exec("
29            CREATE TABLE IF NOT EXISTS products (
30                id INTEGER PRIMARY KEY AUTOINCREMENT,
31                category TEXT NOT NULL,
32                name TEXT NOT NULL
33            );
34        ");
35        echo "products テーブルを作成しました。\n\n";
36
37        // サンプルデータをテーブルに挿入します。
38        // 同じカテゴリの製品が複数存在するようにデータを配置します。
39        $pdo->exec("INSERT INTO products (category, name) VALUES ('Fruits', 'Apple');");
40        $pdo->exec("INSERT INTO products (category, name) VALUES ('Fruits', 'Banana');");
41        $pdo->exec("INSERT INTO products (category, name) VALUES ('Vegetables', 'Carrot');");
42        $pdo->exec("INSERT INTO products (category, name) VALUES ('Vegetables', 'Spinach');");
43        $pdo->exec("INSERT INTO products (category, name) VALUES ('Dairy', 'Milk');");
44        echo "サンプルデータを挿入しました。\n\n";
45
46        // SQLクエリを実行し、結果をフェッチします。
47        // 'category' と 'name' 列を選択し、'category' で結果を並べ替えます。
48        $stmt = $pdo->query("SELECT category, name FROM products ORDER BY category, name");
49
50        // PDO::FETCH_GROUP を使用してデータをフェッチします。
51        // このフェッチスタイルは、結果セットの最初のカラムの値 (ここでは 'category') をキーとして、
52        // そのキーに属する行の配列を値としてグループ化します。
53        // PDO::FETCH_ASSOC を組み合わせることで、各グループ内の行が連想配列として取得されます。
54        $groupedProducts = $stmt->fetchAll(PDO::FETCH_GROUP | PDO::FETCH_ASSOC);
55
56        echo "PDO::FETCH_GROUP を使用してデータをフェッチしました。\n";
57        echo "カテゴリごとに製品をグループ化して表示します:\n";
58
59        // フェッチした結果をループして表示します。
60        // $groupedProducts の構造は ['カテゴリ名' => [ ['name' => '製品名'], ... ], ...] となります。
61        foreach ($groupedProducts as $category => $products) {
62            echo "--- カテゴリ: " . htmlspecialchars($category) . " ---\n";
63            foreach ($products as $product) {
64                // $product は連想配列であり、'name' キーで製品名にアクセスできます。
65                echo "  - " . htmlspecialchars($product['name']) . "\n";
66            }
67        }
68
69    } catch (PDOException $e) {
70        // PDOException が発生した場合 (データベース関連のエラー) の処理
71        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
72    } catch (Exception $e) {
73        // その他の予期せぬエラーが発生した場合の処理
74        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
75    }
76}
77
78// 作成した関数を実行します。
79demonstratePdoFetchGroup();

PDO::FETCH_GROUPは、PHPでデータベースを操作するPDO (PHP Data Objects) が提供する定数の一つです。この定数は、データベースから取得した結果を、特定のカラムの値に基づいて自動的にグループ化して配列として受け取る際に使用します。定数であるため引数はなく、内部的に整数値を持ちます。

サンプルコードでは、SQLiteのインメモリデータベースに接続し、productsテーブルを作成してサンプルデータを挿入しています。その後、SELECT category, name FROM productsというSQLクエリを実行し、結果をPDO::FETCH_GROUP | PDO::FETCH_ASSOCというフェッチスタイルで取得しています。

このPDO::FETCH_GROUPを指定すると、取得した結果セットの最初のカラム（この例ではcategory）の値が最上位の配列のキーとなり、そのキーに属する全ての行がサブ配列としてまとめられます。さらにPDO::FETCH_ASSOCを組み合わせることで、各サブ配列内の行も連想配列として取得されるため、['Fruits' => [['name' => 'Apple'], ['name' => 'Banana']], ...] のような、カテゴリごとに製品が整理された扱いやすいデータ構造が得られます。これにより、データベースから取得したデータを特定の基準で整理し、リスト表示などの処理を簡潔に記述できるため、データ処理の効率化に非常に役立ちます。