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

Copy
1<?php
2
3/**
4 * PDOStatement::fetchObject の使用例を示す関数です。
5 * データベースからデータをオブジェクトとしてフェッチします。
6 * システムエンジニアを目指す初心者向けに、基本的な使い方を解説します。
7 */
8function demonstratePdoFetchObject(): void
9{
10    // インメモリSQLiteデータベースへの接続を試みます。
11    // 実際のアプリケーションでは、MySQLやPostgreSQLなどのデータベースに接続します。
12    // 例: $pdo = new PDO('mysql:host=localhost;dbname=testdb', 'user', 'password');
13    try {
14        $pdo = new PDO('sqlite::memory:');
15        // PDOエラーモードを設定し、エラー発生時に例外をスローするようにします。
16        // これにより、エラーハンドリングが容易になります。
17        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
18        echo "データベースに接続しました。\n";
19
20        // products テーブルを作成します。
21        // id, name, price の3つのカラムを持つ簡単なテーブルです。
22        $pdo->exec(
23            "CREATE TABLE IF NOT EXISTS products (
24                id INTEGER PRIMARY KEY AUTOINCREMENT,
25                name TEXT NOT NULL,
26                price REAL NOT NULL
27            );"
28        );
29        echo "products テーブルを作成しました。\n";
30
31        // サンプルデータをproductsテーブルに挿入します。
32        // プリペアドステートメントを使用することで、SQLインジェクション攻撃を防ぎます。
33        $stmt = $pdo->prepare("INSERT INTO products (name, price) VALUES (:name, :price)");
34        $stmt->execute([':name' => 'Apple', ':price' => 1.50]);
35        $stmt->execute([':name' => 'Banana', ':price' => 0.75]);
36        $stmt->execute([':name' => 'Orange', ':price' => 1.20]);
37        echo "サンプルデータを挿入しました。\n\n";
38
39        // --- 1. デフォルト (stdClass) でオブジェクトをフェッチする例 ---
40        // fetchObject() の引数を省略すると、PHPの組み込みクラスである stdClass のインスタンスとしてデータが返されます。
41        // stdClass は、プロパティを動的に追加できる汎用的なオブジェクトです。
42        echo "--- stdClass としてデータをフェッチ ---\n";
43        $stmt = $pdo->query("SELECT id, name, price FROM products");
44        while ($product = $stmt->fetchObject()) {
45            // $product は stdClass のオブジェクトで、データベースのカラム名がプロパティ名になります。
46            echo "ID: " . $product->id . ", 名前: " . $product->name . ", 価格: " . $product->price . "\n";
47            // var_dump($product); // オブジェクトの内容と型を確認したい場合にコメントを解除
48        }
49        echo "\n";
50
51        // カスタムクラスの定義
52        // データベースの行を表現するための独自のクラスを定義できます。
53        // PHP 8では、プロパティに型ヒントを追加することが推奨されます。
54        class Product
55        {
56            public int $id;
57            public string $name;
58            public float $price;
59
60            // クラスに独自のメソッドを追加して、データ操作や表示ロジックをカプセル化できます。
61            public function getDisplayPrice(): string
62            {
63                return '$' . number_format($this->price, 2);
64            }
65        }
66
67        // --- 2. カスタムクラスでオブジェクトをフェッチする例 ---
68        // fetchObject() の第1引数にカスタムクラスの名前 (完全修飾名または Product::class) を指定することで、
69        // そのクラスのインスタンスとしてデータベースの行をフェッチできます。
70        echo "--- カスタム Product クラスとしてデータをフェッチ ---\n";
71        $stmt = $pdo->query("SELECT id, name, price FROM products");
72        // Product::class を指定することで、Product クラスのインスタンスとしてデータを取得します。
73        while ($product = $stmt->fetchObject(Product::class)) {
74            // $product は Product クラスのオブジェクトとなり、定義したメソッドを使用できます。
75            echo "ID: " . $product->id . ", 名前: " . $product->name . ", 表示価格: " . $product->getDisplayPrice() . "\n";
76            // var_dump($product); // オブジェクトの内容と型を確認したい場合にコメントを解除
77        }
78        echo "\n";
79
80    } catch (PDOException $e) {
81        // データベース接続やクエリ実行中にエラーが発生した場合、ここで捕捉します。
82        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
83    } finally {
84        // スクリプトの終了時にPDOオブジェクトは自動的に破棄されますが、
85        // 明示的に null を代入することで接続を閉じることができます。
86        $pdo = null;
87        echo "データベース接続を閉じました。\n";
88    }
89}
90
91// demonstratePdoFetchObject 関数を実行します。
92demonstratePdoFetchObject();

PHPのPDOStatement::fetchObjectメソッドは、データベースから取得した1行のデータをオブジェクトとして受け取るための機能です。このメソッドは、PDOStatement::queryやPDOStatement::prepareで準備されたSQLステートメントを実行した結果から、次の行をオブジェクト形式で返します。

引数$classには、データを格納するクラスの名前を文字列で指定します。この引数を省略した場合、PHPの標準クラスであるstdClassのインスタンスとしてデータが返され、データベースのカラム名がオブジェクトのプロパティとなります。もし独自のカスタムクラス（例えばProductクラス）の名前を指定すると、そのクラスのインスタンスが作成され、データベースのカラム値が対応するプロパティに自動的に設定されます。これにより、カスタムクラスに定義したメソッド（例：getDisplayPrice()）を用いて、データに特定の処理や表示ロジックをカプセル化できる利点があります。引数$constructorArgsは、カスタムクラスのコンストラクタに渡す引数を配列で指定しますが、通常は省略されます。

このメソッドは、データが残っている場合はオブジェクトを返し、取得すべきデータがもうない場合はfalseを返します。そのため、サンプルコードのようにwhileループでfetchObject()の結果がfalseでない間、繰り返しデータを処理するのが一般的な使い方です。データベース接続やデータの挿入時には、SQLインジェクション攻撃を防ぐためにプリペアドステートメントを使い、エラーが発生した際にはtry-catchブロックで適切に例外を処理することが、堅牢なシステムを構築する上で重要です。