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

Copy
1<?php
2
3/**
4 * PDO::FETCH_CLASSTYPE の動作を示すための基底クラス
5 * データベースの 'type' カラムの値に基づいて、この基底クラスを継承した
6 * 特定のクラス（例: Product, Service）が動的にインスタンス化されます。
7 */
8class BaseItem
9{
10    public int $id;
11    public string $name;
12    public float $price;
13    public string $type; // このプロパティにデータベースからクラス名が設定されます
14
15    /**
16     * アイテムの基本情報を表示します。
17     */
18    public function displayInfo(): void
19    {
20        echo "ID: {$this->id}, Name: {$this->name}, Price: {$this->price}, Type: {$this->type}";
21    }
22}
23
24/**
25 * 商品アイテムを表すクラス
26 * BaseItem を継承しています。
27 */
28class Product extends BaseItem
29{
30    /**
31     * 商品情報を表示します。
32     * 親クラスの情報を表示し、追加で「これは商品です」と出力します。
33     */
34    public function displayInfo(): void
35    {
36        parent::displayInfo();
37        echo " [これは商品です]";
38    }
39}
40
41/**
42 * サービスアイテムを表すクラス
43 * BaseItem を継承しています。
44 */
45class Service extends BaseItem
46{
47    /**
48     * サービス情報を表示します。
49     * 親クラスの情報を表示し、追加で「これはサービスです」と出力します。
50     */
51    public function displayInfo(): void
52    {
53        parent::displayInfo();
54        echo " [これはサービスです]";
55    }
56}
57
58/**
59 * PDO::FETCH_CLASSTYPE を使用してデータベースから動的にクラスインスタンスを生成するサンプルコード。
60 *
61 * この関数は、インメモリの SQLite データベースを設定し、
62 * 'type' カラムの値に基づいて異なるクラスのオブジェクトをフェッチする方法を示します。
63 * フェッチされたオブジェクトのクラス名と型も確認します。
64 */
65function demonstrateFetchClasstype(): void
66{
67    try {
68        // データベース接続 (インメモリ SQLite を使用)
69        // 実際のシステムでは、永続的なデータベース接続設定を使用します。
70        $pdo = new PDO('sqlite::memory:');
71        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
72        $pdo->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_ASSOC);
73
74        echo "データベース接続に成功しました。\n";
75
76        // 'items' テーブルの作成
77        // 'type' カラムには、インスタンス化したいクラス名（例: 'Product', 'Service'）を保存します。
78        $pdo->exec(
79            "CREATE TABLE items (
80                id INTEGER PRIMARY KEY AUTOINCREMENT,
81                name TEXT NOT NULL,
82                price REAL NOT NULL,
83                type TEXT NOT NULL
84            )"
85        );
86        echo "テーブル 'items' を作成しました。\n";
87
88        // サンプルデータの挿入
89        $pdo->exec("INSERT INTO items (name, price, type) VALUES ('Laptop', 1200.00, 'Product')");
90        $pdo->exec("INSERT INTO items (name, price, type) VALUES ('Annual Subscription', 99.99, 'Service')");
91        $pdo->exec("INSERT INTO items (name, price, type) VALUES ('Monitor', 300.50, 'Product')");
92        echo "サンプルデータを挿入しました。\n\n";
93
94        // SQL クエリを実行して PDOStatement オブジェクトを取得
95        $stmt = $pdo->query("SELECT id, name, price, type FROM items");
96
97        // フェッチモードを PDO::FETCH_CLASS と PDO::FETCH_CLASSTYPE に設定
98        // PDO::FETCH_CLASSTYPE は PDO::FETCH_CLASS と組み合わせて使用され、
99        // 第2引数で指定されたカラム（ここでは 'type'）の値に基づいてクラス名を決定します。
100        // そのクラス名に一致するクラスのインスタンスが作成されます。
101        $stmt->setFetchMode(PDO::FETCH_CLASS | PDO::FETCH_CLASSTYPE, 'type');
102
103        echo "PDO::FETCH_CLASSTYPE を使用してデータをフェッチします:\n";
104
105        // 結果セットをループして、フェッチされた各オブジェクトの情報を表示
106        while ($item = $stmt->fetch()) {
107            // フェッチされたオブジェクトのカスタムメソッドを呼び出す
108            $item->displayInfo();
109
110            // オブジェクトの具体的なクラス名を確認する (get_class())
111            echo ", 実クラス: " . get_class($item);
112
113            // 変数の型を確認する (gettype())
114            // オブジェクトの場合、gettype() は常に 'object' を返します。
115            // 具体的なクラス名を知るには get_class() を使用します。
116            echo ", 変数型: " . gettype($item) . "\n";
117        }
118
119    } catch (PDOException $e) {
120        // データベース関連のエラーを捕捉
121        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
122        exit(1);
123    } catch (Exception $e) {
124        // その他の予期せぬエラーを捕捉
125        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
126        exit(1);
127    }
128}
129
130// 関数の実行
131demonstrateFetchClasstype();
132
133?>

PDO::FETCH_CLASSTYPEは、PHPのデータベース操作ライブラリであるPDOにおいて、データベースからデータを取得する際のフェッチモードを指定する定数の一つです。この定数自体には引数や戻り値はありません。主にPDO::FETCH_CLASSと組み合わせて使用され、データベースの特定のカラムに保存された文字列をクラス名として解釈し、そのクラスのオブジェクトを動的に生成する機能を提供します。

サンプルコードでは、BaseItemクラスとその子クラスであるProductとServiceが定義されています。データベースのitemsテーブルには、typeカラムにProductやServiceといったクラス名が格納されています。$stmt->setFetchMode(PDO::FETCH_CLASS | PDO::FETCH_CLASSTYPE, 'type')と設定することで、fetch()メソッドが呼ばれた際に、typeカラムの値に応じて自動的にProductまたはServiceクラスのインスタンスが作成されます。

これにより、取得した$itemオブジェクトは、データベースのデータに応じて異なるクラスのメソッド（例: displayInfo())を呼び出すことができ、多態的な処理をPHP側で実現できます。get_class($item)関数を使用すると、実際にどのクラスのオブジェクトが生成されたかを確認できます。一方、gettype($item)関数は、PHPの変数型として常に「object」を返します。この機能は、データベースに保存された情報に基づいて、柔軟に異なるオブジェクトを生成したい場合に非常に有用です。

Copy
1<?php
2
3/**
4 * データベースからユーザーデータを取得し、連想配列形式で表示するサンプル関数です。
5 * システムエンジニアを目指す初心者向けに、PDOとPDO::FETCH_ASSOCの使用例を示します。
6 * これは、一般的に「fetch_assoc()」と呼ばれる連想配列でのデータ取得方法に相当します。
7 */
8function fetchUserDataAsAssocArray(): void
9{
10    // データベース接続情報
11    // 自身の環境に合わせて適宜変更してください (例: データベース名、ユーザー名、パスワード)
12    $dsn = 'mysql:host=localhost;dbname=testdb;charset=utf8mb4';
13    $user = 'root';
14    $password = ''; // 適切なパスワードを設定してください。開発環境によっては空の場合もあります。
15
16    try {
17        // PDO (PHP Data Objects) インスタンスを作成し、データベースに接続
18        // エラーモードを例外(PDOException)に設定し、データベース操作でエラーが発生した場合に捕捉できるようにします。
19        $pdo = new PDO($dsn, $user, $password, [
20            PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
21            // PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC, // デフォルトのフェッチモードを連想配列に設定することも可能
22        ]);
23
24        echo "データベースに接続しました。\n";
25
26        // サンプルテーブル 'users' の作成 (既に存在する場合は何もしません)
27        $pdo->exec("
28            CREATE TABLE IF NOT EXISTS users (
29                id INT AUTO_INCREMENT PRIMARY KEY,
30                name VARCHAR(255) NOT NULL,
31                email VARCHAR(255) NOT NULL UNIQUE
32            );
33        ");
34        echo "テーブル 'users' の存在を確認または作成しました。\n";
35
36        // サンプルデータの挿入 (既に同じメールアドレスのデータがある場合は挿入しません)
37        $stmtCheck = $pdo->prepare("SELECT COUNT(*) FROM users WHERE email = ?");
38        $stmtCheck->execute(['alice@example.com']);
39        if ($stmtCheck->fetchColumn() == 0) {
40            $stmtInsert = $pdo->prepare("INSERT INTO users (name, email) VALUES (?, ?)");
41            $stmtInsert->execute(['Alice', 'alice@example.com']);
42            echo "サンプルデータを挿入しました。\n";
43        }
44
45        // 'users' テーブルから全てのユーザーデータを取得するSQL文を実行
46        $stmt = $pdo->query("SELECT id, name, email FROM users");
47
48        echo "\n--- ユーザーデータ (連想配列形式) ---\n";
49        // PDOStatement::fetch() メソッドを PDO::FETCH_ASSOC フラグと共に使用し、
50        // データを連想配列として1行ずつ取得します。
51        // これは、キーワードである `fetch_assoc()` の動作に最も近い形式です。
52        //
53        // 補足: PDO::FETCH_CLASSTYPE は、取得したデータを指定されたクラスのインスタンスとして
54        // フェッチするためのPDO定数であり、本例の連想配列取得とは異なる高度なフェッチモードです。
55        while ($row = $stmt->fetch(PDO::FETCH_ASSOC)) {
56            echo "ID: " . $row['id'] . ", 名前: " . $row['name'] . ", メール: " . $row['email'] . "\n";
57        }
58        echo "-----------------------------------\n";
59
60    } catch (PDOException $e) {
61        // データベース接続やクエリ実行中に発生したPDOExceptionを捕捉し、エラーメッセージを表示
62        echo "データベース操作中にエラーが発生しました: " . $e->getMessage() . "\n";
63        // 実際のシステムでは、このエラー情報をログファイルに記録するなど、より適切な処理を行います。
64    } finally {
65        // PDOオブジェクトをNULLに設定することでデータベース接続を閉じます。
66        // PHPスクリプトの終了時に自動的に閉じられますが、明示的に行うことも可能です。
67        $pdo = null;
68        echo "データベース接続を閉じました。\n";
69    }
70}
71
72// 定義した関数を実行します。
73fetchUserDataAsAssocArray();
74
75?>

このPHPサンプルコードは、データベースからデータを取得し、連想配列形式で扱う基本的な方法をシステムエンジニアを目指す初心者向けに解説します。

データベースへの接続には、PHP Data Objects (PDO) を利用します。PDOは、様々なデータベースに統一的な方法でアクセスするための機能を提供するクラスです。サンプルではnew PDO(...)で接続を確立し、エラー発生時には例外を投げる設定をしています。

データベースからデータを読み出す際、PDOStatementオブジェクトのfetch()メソッドにPDO::FETCH_ASSOC定数を指定します。これにより、取得したデータが「列名をキー、データを値」とする連想配列として返されます。この形式は、キーワードである「fetch_assoc()」と呼ばれる連想配列でのデータ取得方法に相当し、データを直感的に利用できるため非常に一般的です。

リファレンス情報にあるPDO::FETCH_CLASSTYPEは、本サンプルで利用している連想配列形式とは異なり、取得したデータを指定されたクラスのインスタンスとして自動的に生成するための高度なフェッチモード定数です。この定数自体は引数を取らず、直接の戻り値もありませんが、fetch()メソッドに渡すことでデータの取得形式を制御します。

サンプルコード内のfetchUserDataAsAssocArray()関数は引数を取りません。また、データベースから取得したデータを画面に出力する役割を持ち、明示的な戻り値は設定されていません（void）。