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

Copy
1<?php
2
3/**
4 * PDOStatementを継承したカスタムステートメントクラス。
5 * このクラスをPDOに設定することで、SQLクエリの実行や結果の取得時に
6 * 独自のロジックを追加したり、特定の処理をフックしたりできます。
7 * 例えば、全てのクエリの実行時間をログに記録したり、取得したデータを自動的に整形したりする用途に利用できます。
8 */
9class MyCustomStatement extends PDOStatement
10{
11    /**
12     * PDOがprepare()などを呼び出して、このカスタムクラスのインスタンスを生成する際に
13     * このコンストラクタが呼び出されます。
14     * PDOStatementは内部的に処理されるため、直接親のコンストラクタを呼び出す必要はありません。
15     */
16    protected function __construct()
17    {
18        // ここにカスタムステートメントインスタンスが生成された際の初期化処理を追加できます。
19        // 例: ロギングの初期設定、特定のプロパティの初期化など
20    }
21
22    /**
23     * SQLステートメントを実行するメソッドをオーバーライドします。
24     * 親のexecute()メソッドの前後で独自の処理を追加できます。
25     *
26     * @param array|null $input_parameters プレースホルダにバインドするパラメータの配列。
27     * @return bool 成功した場合はtrue、失敗した場合はfalse。
28     */
29    public function execute(?array $input_parameters = null): bool
30    {
31        // クエリ実行前の処理 (例: クエリのロギング、実行開始時刻の記録)
32        // echo "--- MyCustomStatement::execute() が呼び出されました ---" . PHP_EOL; // デバッグ用
33
34        // 親クラスのexecute()メソッドを呼び出し、実際のSQLを実行します。
35        $result = parent::execute($input_parameters);
36
37        // クエリ実行後の処理 (例: 実行時間の記録、成功/失敗のログ出力)
38        return $result;
39    }
40
41    /**
42     * 結果セットから次の行を取得するメソッドをオーバーライドします。
43     * 取得したデータに対して独自の処理を追加できます。
44     *
45     * @param int|null $mode PDO::FETCH_ASSOC, PDO::FETCH_NUM, PDO::FETCH_OBJ など。
46     * @param int $cursorOrientation カーソルの方向。PDO::FETCH_ORI_NEXT など。
47     * @param int $cursorOffset カーソルのオフセット。
48     * @return mixed 取得したデータ行、またはデータがない場合はfalse。
49     */
50    public function fetch($mode = null, $cursorOrientation = PDO::FETCH_ORI_NEXT, $cursorOffset = 0)
51    {
52        // 親クラスのfetch()メソッドを呼び出し、実際にデータを取得します。
53        $row = parent::fetch($mode, $cursorOrientation, $cursorOffset);
54
55        if ($row !== false) {
56            // echo "--- MyCustomStatement::fetch() でデータを取得しました ---" . PHP_EOL; // デバッグ用
57            // 取得したデータ($row)に対して、例えば特定の値を整形する、監査ログを出力するなどの
58            // カスタム処理を行うことができます。
59            // 例: $row['name'] = strtoupper($row['name']); // 名前の文字列を大文字に変換
60        }
61        return $row;
62    }
63}
64
65/**
66 * PDO::ATTR_STATEMENT_CLASS を使用してカスタムPDOStatementクラスを設定する例。
67 * システムエンジニアを目指す初心者向けに、カスタムクラスの利点を示します。
68 */
69function demonstratePdoAttrStatementClass(): void
70{
71    // SQLiteのインメモリデータベースを使用し、ファイルシステムへの書き込みを避けます。
72    $dsn = 'sqlite::memory:';
73    $user = null; // SQLiteではユーザー名とパスワードは通常不要
74    $password = null;
75    $options = [
76        // エラー発生時にPDOExceptionをスローするように設定し、エラーハンドリングを容易にします。
77        PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
78        // 結果セットのカラム名を元のケースで返すように設定します。
79        PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,
80    ];
81
82    try {
83        // 1. PDOインスタンスを作成します。
84        $pdo = new PDO($dsn, $user, $password, $options);
85        echo "データベースに接続しました。" . PHP_EOL;
86
87        // 2. テスト用のテーブルを作成し、データを挿入します。
88        $pdo->exec("
89            CREATE TABLE users (
90                id INTEGER PRIMARY KEY AUTOINCREMENT,
91                name TEXT NOT NULL
92            );
93        ");
94        $pdo->exec("INSERT INTO users (name) VALUES ('Alice')");
95        $pdo->exec("INSERT INTO users (name) VALUES ('Bob')");
96        echo "テストデータを作成しました。" . PHP_EOL . PHP_EOL;
97
98        // --- デフォルトのPDOStatementクラスの動作確認 ---
99        echo "--- デフォルトのPDOStatementクラスを使用した場合 ---" . PHP_EOL;
100        $stmtDefault = $pdo->prepare("SELECT id, name FROM users WHERE id = :id");
101        $id = 1;
102        $stmtDefault->bindParam(':id', $id, PDO::PARAM_INT);
103        $stmtDefault->execute();
104        echo "デフォルトのStatementクラス: " . get_class($stmtDefault) . PHP_EOL;
105        $userDefault = $stmtDefault->fetch();
106        echo "取得データ (id=1): " . json_encode($userDefault) . PHP_EOL . PHP_EOL;
107        // ステートメントオブジェクトは、不要になったらnullを設定してリソースを解放するのが良い習慣です。
108        $stmtDefault = null;
109
110        // --- PDO::ATTR_STATEMENT_CLASS を設定してカスタムクラスを使用 ---
111        echo "--- カスタムのMyCustomStatementクラスを使用した場合 ---" . PHP_EOL;
112
113        // PDO::ATTR_STATEMENT_CLASS を設定し、以降の prepare() や query() が
114        // MyCustomStatement のインスタンスを返すようにします。
115        // 第2要素にカスタムステートメントクラスのコンストラクタに渡す引数を配列で指定できますが、
116        // 今回は不要なため、クラス名のみの配列とします。
117        $pdo->setAttribute(PDO::ATTR_STATEMENT_CLASS, [MyCustomStatement::class]);
118
119        // prepare() を呼び出すと、MyCustomStatement のインスタンスが返されます。
120        $stmtCustom = $pdo->prepare("SELECT id, name FROM users WHERE id = :id");
121        echo "カスタムStatementクラス: " . get_class($stmtCustom) . PHP_EOL;
122
123        $id = 2; // Bobの情報を取得
124        $stmtCustom->bindParam(':id', $id, PDO::PARAM_INT);
125        $stmtCustom->execute(); // MyCustomStatement::execute() が呼び出される
126        $userCustom = $stmtCustom->fetch(); // MyCustomStatement::fetch() が呼び出される
127        echo "取得データ (id=2): " . json_encode($userCustom) . PHP_EOL . PHP_EOL;
128
129    } catch (PDOException $e) {
130        // データベース関連のエラーが発生した場合にキャッチします。
131        echo "データベースエラーが発生しました: " . $e->getMessage() . PHP_EOL;
132        exit(1); // エラー終了
133    } catch (Exception $e) {
134        // PDOException以外の予期せぬエラーをキャッチします。
135        echo "予期せぬエラーが発生しました: " . $e->getMessage() . PHP_EOL;
136        exit(1); // エラー終了
137    } finally {
138        // PDOオブジェクトがスコープを外れると自動的に接続は閉じられますが、
139        // 明示的にnullを設定することで、リソース解放を早めることができます。
140        $pdo = null;
141        echo "データベース接続を閉じました。" . PHP_EOL;
142    }
143}
144
145// サンプル関数を実行します。
146demonstratePdoAttrStatementClass();

PHPのPDO::ATTR_STATEMENT_CLASSは、データベース操作を行うPDO拡張機能で利用される定数です。この定数をPDO接続オプションとして設定することで、SQLクエリの準備や実行、結果の取得を行うPDOStatementオブジェクトの代わりに、ユーザーが独自に定義したカスタムクラスを使用できるようになります。

カスタムクラスはPDOStatementを継承して作成し、execute()やfetch()といったメソッドをオーバーライドすることで、SQLクエリの実行前後にログを記録したり、取得したデータを自動的に整形したりするなど、独自の処理を組み込むことが可能になります。これにより、アプリケーション全体で一貫したデータベース関連の振る舞いを簡単に実装できる点が大きな利点です。

サンプルコードでは、MyCustomStatementクラスを定義し、そのクラスをPDO::ATTR_STATEMENT_CLASSに設定しています。この設定後、$pdo->prepare()で生成されるステートメントオブジェクトはMyCustomStatementのインスタンスとなり、クエリ実行時やデータ取得時にMyCustomStatement内で定義されたカスタムロジックが実行されます。この定数自体に引数や戻り値はありませんが、PDO::setAttribute()メソッドの第2引数に、使用したいカスタムクラス名を配列として渡して設定します。システムエンジニアを目指す方にとって、データベース操作の柔軟性を高める重要な機能です。

Copy
1<?php
2
3/**
4 * カスタムPDOStatementクラスの定義。
5 * PDO::ATTR_STATEMENT_CLASS 属性にこのクラスを指定することで、
6 * PDOが返すステートメントオブジェクトをこのクラスのインスタンスに置き換えることができます。
7 * ここでは、追加のカスタムメソッド (customFetch) を提供しています。
8 */
9class MyCustomStatement extends PDOStatement
10{
11    /**
12     * カスタムフェッチメソッドの例。
13     * 親クラスのfetchメソッドを呼び出し、必要に応じて取得したデータに追加処理を行うことができます。
14     *
15     * @return array|false フェッチされた行、またはデータがない場合は false
16     */
17    public function customFetch(): array|false
18    {
19        // 親クラスの fetch メソッドを呼び出す (PDO::FETCH_ASSOC を明示的に指定)
20        $result = parent::fetch(PDO::FETCH_ASSOC);
21
22        if ($result) {
23            // 例: フェッチしたデータにカスタムな処理を追加する
24            // ここでは 'name' を大文字に変換して 'processed_name' として追加しています
25            $result['processed_name'] = strtoupper($result['name']);
26        }
27
28        return $result;
29    }
30}
31
32try {
33    // 1. PDO接続の確立
34    // SQLiteのインメモリデータベースを使用することで、ファイル作成なしで単体動作可能です。
35    $dsn = 'sqlite::memory:';
36
37    // データベース接続オプションの設定
38    $options = [
39        // エラーモードを例外に設定: データベースエラーが発生した際にPDOExceptionをスローします。
40        // これにより、エラーハンドリングが容易になります。
41        PDO::ATTR_ERRMODE            => PDO::ERRMODE_EXCEPTION,
42
43        // プリペアドステートメントのエミュレーションを無効化:
44        // 真のプリペアドステートメントを使用し、セキュリティとパフォーマンスを向上させます。
45        PDO::ATTR_EMULATE_PREPARES   => false,
46
47        // デフォルトのフェッチモードを連想配列に設定:
48        // (キーワード: pdo attr_default_fetch_mode に関連)
49        // fetch() メソッドの引数を省略した場合、結果が連想配列として返されます。
50        PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,
51
52        // カスタムPDOStatementクラスを設定:
53        // (リファレンス情報: PDO::ATTR_STATEMENT_CLASS に関連)
54        // PDOがクエリ実行後に返すPDOStatementオブジェクトの代わりに、
55        // MyCustomStatementクラスのインスタンスを使用するよう指示します。
56        // PHP 8以降ではクラス名を配列で渡すことが推奨されます。
57        PDO::ATTR_STATEMENT_CLASS    => [MyCustomStatement::class],
58    ];
59
60    // PDOオブジェクトを作成し、データベースに接続します
61    $pdo = new PDO($dsn, null, null, $options);
62
63    echo "データベース接続に成功しました。\n";
64
65    // 2. テーブルの作成
66    $pdo->exec("CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY, name TEXT)");
67    echo "テーブル 'users' を作成しました。\n";
68
69    // 3. データの挿入
70    $pdo->exec("INSERT INTO users (name) VALUES ('Alice')");
71    $pdo->exec("INSERT INTO users (name) VALUES ('Bob')");
72    echo "データを挿入しました。\n";
73
74    // 4. データを選択し、カスタムステートメントクラスの動作を確認
75    // PDO::query() は、MyCustomStatementのインスタンスを返します。
76    $stmt = $pdo->query("SELECT id, name FROM users");
77
78    // 返されたオブジェクトがMyCustomStatementのインスタンスであることを確認
79    if ($stmt instanceof MyCustomStatement) {
80        echo "\nPDO::query() がカスタムクラス 'MyCustomStatement' のインスタンスを返しました。\n";
81
82        // カスタムメソッドを使用して結果をフェッチ
83        echo "MyCustomStatement::customFetch() を使用してデータをフェッチ:\n";
84        while ($row = $stmt->customFetch()) {
85            echo "  ID: {$row['id']}, Name: {$row['name']}, Processed Name: {$row['processed_name']}\n";
86        }
87
88        // カーソルをリセットして再度フェッチ (デモのため)
89        $stmt->execute();
90
91        // デフォルトの fetch() メソッドを使用し、ATTR_DEFAULT_FETCH_MODE の効果を確認
92        echo "\nPDO::ATTR_DEFAULT_FETCH_MODE (連想配列) が適用されたデフォルトの fetch() を使用してデータをフェッチ:\n";
93        while ($row = $stmt->fetch()) {
94            echo "  ID: {$row['id']}, Name: {$row['name']}\n";
95        }
96
97    } else {
98        echo "エラー: PDO::query() が MyCustomStatement のインスタンスを返しませんでした。\n";
99        // デフォルトのフェッチモードでフェッチ (カスタムクラスが適用されなかった場合)
100        echo "\nデフォルトの fetch() を使用してデータをフェッチ:\n";
101        while ($row = $stmt->fetch()) {
102            echo "  ID: {$row['id']}, Name: {$row['name']}\n";
103        }
104    }
105
106} catch (PDOException $e) {
107    // データベース接続またはクエリ実行で発生した例外をキャッチし、エラーメッセージを表示
108    echo "エラーが発生しました: " . $e->getMessage() . "\n";
109}
110
111?>

PDO::ATTR_STATEMENT_CLASSは、PHPのデータベース接続を扱うPDO拡張機能において、SQL実行後に結果を保持するPDOStatementオブジェクトを、独自のカスタムクラスのインスタンスに置き換えるための設定値です。この定数自体に引数や戻り値はありませんが、PDO接続時のオプションとしてカスタムクラス名を指定することで、標準のPDOStatementの代わりに、独自の機能を持つオブジェクトを利用できるようになります。

サンプルコードでは、PDOStatementを継承したMyCustomStatementクラスを定義し、親クラスのfetch()メソッドを拡張して取得データに加工処理（ここではユーザー名を大文字化）を加えるcustomFetch()メソッドを追加しています。そして、PDO接続時にPDO::ATTR_STATEMENT_CLASSオプションに[MyCustomStatement::class]を設定することで、$pdo->query()などで取得されるステートメントオブジェクトがMyCustomStatementのインスタンスとなります。これにより、データ取得時にcustomFetch()メソッドを呼び出し、加工済みのデータを容易に扱うことが可能になります。

また、PDO::ATTR_DEFAULT_FETCH_MODEはfetch()メソッドのデフォルトのデータ取得形式（例: 連想配列）を設定するのに対し、ATTR_STATEMENT_CLASSは、データを取得するオブジェクト自体をカスタマイズする点で役割が異なります。この設定を活用することで、アプリケーション内で共通のデータ処理を強制したり、特定の追加機能を持つステートメントオブジェクトを実装したりできるため、コードの品質と保守性の向上が期待できます。