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

Copy
1<?php
2
3/**
4 * PDOStatement::getAttribute メソッドの使用例を示します。
5 * このメソッドは、プリペアドステートメントの特定の属性の値を取得します。
6 *
7 * システムエンジニアを目指す初心者の方へ：
8 * PDOStatementは、データベースへのクエリを準備した後に得られるオブジェクトです。
9 * getAttributeは、その準備されたクエリがどのような設定（属性）を持っているかを確認するために使います。
10 * 例えば、データベースがデータをどのように扱うか（カーソルの種類など）を確認できます。
11 */
12function demonstratePdoStatementGetAttribute(): void
13{
14    try {
15        // 1. データベース接続 (SQLiteをメモリ内で使用し、外部ファイルへの依存をなくします)
16        // エラー発生時にPDOExceptionをスローするよう設定します。
17        $pdo = new PDO('sqlite::memory:');
18        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
19
20        // 2. サンプルテーブルの作成とデータの挿入
21        $pdo->exec("CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY, name TEXT)");
22        $pdo->exec("INSERT INTO users (name) VALUES ('Alice'), ('Bob')");
23
24        // 3. プリペアドステートメントの準備
25        // クエリを準備すると、PDOStatementオブジェクトが返されます。
26        $stmt = $pdo->prepare("SELECT id, name FROM users WHERE id = :id");
27
28        // 4. PDOStatement::getAttribute を使用して属性を取得
29        // PDO::ATTR_CURSOR は、ステートメントが使用するカーソルの種類を定義します。
30        // デフォルトでは PDO::CURSOR_FWDONLY (前方参照のみ) に設定されています。
31        $cursorType = $stmt->getAttribute(PDO::ATTR_CURSOR);
32
33        // 5. 取得した結果を出力
34        echo "PDOStatement::getAttribute の使用例:\n";
35        echo "ステートメントのカーソルタイプ: " . $cursorType . "\n";
36
37        // 取得したカーソルタイプがデフォルトであるか確認します。
38        // PDO::CURSOR_FWDONLY は通常 0 という数値に解決されます。
39        if ($cursorType === PDO::CURSOR_FWDONLY) {
40            echo "(これはデフォルトの前方参照のみカーソルです: PDO::CURSOR_FWDONLY)\n";
41        }
42
43    } catch (PDOException $e) {
44        // データベース関連のエラーが発生した場合に表示します。
45        echo "データベースエラー: " . $e->getMessage() . "\n";
46    }
47}
48
49// 関数を実行し、サンプルコードを動作させます。
50demonstratePdoStatementGetAttribute();

PHPのPDOStatement::getAttributeメソッドは、データベースへのクエリを準備した後に得られるPDOStatementオブジェクトが持つ特定の属性の値を取得するために使用されます。システムエンジニアを目指す初心者の方にとって、これは準備されたデータベースクエリがどのような設定で動作するかを確認する際に役立ちます。例えば、データベースがデータをどのように扱うかを示すカーソルの種類などを確認できます。

このメソッドの引数int $nameには、取得したい属性の種類をPDO::ATTR_XXXのような定数で指定します。例えば、カーソルタイプを取得したい場合はPDO::ATTR_CURSORを指定します。戻り値はmixed型で、取得する属性によってその値の型は異なります。

サンプルコードでは、まずデータベース接続後、$pdo->prepare()でSQLクエリのプリペアドステートメントを作成し、PDOStatementオブジェクトを得ています。そして、$stmt->getAttribute(PDO::ATTR_CURSOR)を呼び出すことで、このプリペアドステートメントが使用しているカーソルの種類を取得しています。多くの場合、デフォルトではPDO::CURSOR_FWDONLY（前方参照のみ）が設定されており、サンプルコードではその値が正しく取得され、表示されることを確認しています。このように、getAttributeはデータベース操作において、準備されたクエリの内部設定をプログラムから確認する際に便利な機能です。

Copy
1<?php
2
3/**
4 * PDOStatement::getAttribute の使用例。
5 * プリペアドステートメントの特定の属性を取得する方法を示します。
6 */
7function demonstratePdoStatementGetAttribute(): void
8{
9    // データベース接続設定 (SQLite インメモリデータベースを使用し、単体で動作可能にする)
10    $dsn = 'sqlite::memory:';
11    $username = null; // SQLiteの場合、通常ユーザー名とパスワードは不要
12    $password = null;
13    $options = [
14        PDO::ATTR_ERRMODE            => PDO::ERRMODE_EXCEPTION, // エラー発生時に例外をスロー
15        PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,       // デフォルトのフェッチモードを連想配列に設定
16    ];
17
18    try {
19        $pdo = new PDO($dsn, $username, $password, $options);
20        echo "データベースに接続しました。\n";
21
22        // テーブル作成 (例として products テーブル)
23        $pdo->exec("CREATE TABLE IF NOT EXISTS products (id INTEGER PRIMARY KEY, name TEXT, price REAL)");
24        echo "テーブル 'products' を作成しました。\n";
25
26        // ダミーデータの挿入
27        $pdo->exec("INSERT INTO products (name, price) VALUES ('Apple', 1.00)");
28        $pdo->exec("INSERT INTO products (name, price) VALUES ('Banana', 0.50)");
29        echo "ダミーデータを挿入しました。\n";
30
31        // プリペアドステートメントを作成し、PDO::prepare のオプションで属性を設定します。
32        // PDO::ATTR_CURSOR_NAME は、主にスクロール可能なカーソルで使用される属性ですが、
33        // PDOStatementオブジェクトに設定され、getAttributeで取得できる属性の良い例として使用します。
34        $stmt = $pdo->prepare(
35            'SELECT name, price FROM products WHERE id = :id',
36            [PDO::ATTR_CURSOR_NAME => 'product_query_cursor'] // ステートメントにカーソル名を設定
37        );
38        echo "プリペアドステートメントを作成し、カーソル名を設定しました。\n";
39
40        // PDOStatement::getAttribute を使用して、設定したカーソル名を取得します。
41        // 引数には取得したい属性の定数を指定します。
42        $cursorName = $stmt->getAttribute(PDO::ATTR_CURSOR_NAME);
43
44        if ($cursorName !== false) {
45            echo "PDOStatementから取得したカーソル名: " . $cursorName . "\n";
46        } else {
47            echo "カーソル名属性を取得できませんでした。\n";
48        }
49
50        // ステートメントの実行例 (属性の取得とは直接関係ありませんが、コードの流れとして示します)
51        $id = 1;
52        $stmt->bindParam(':id', $id, PDO::PARAM_INT);
53        $stmt->execute();
54        $result = $stmt->fetch();
55
56        if ($result) {
57            echo "取得した商品: " . $result['name'] . " (価格: " . $result['price'] . ")\n";
58        } else {
59            echo "指定されたIDの商品が見つかりませんでした。\n";
60        }
61
62        echo "処理を完了しました。\n";
63
64    } catch (PDOException $e) {
65        // データベース接続または操作でエラーが発生した場合
66        echo "データベースエラー: " . $e->getMessage() . "\n";
67        exit(1);
68    }
69}
70
71// 上記で定義した関数を実行します。
72demonstratePdoStatementGetAttribute();

PHPのPDOStatement::getAttributeメソッドは、データベース操作で使用する「プリペアドステートメント」（PDOStatementオブジェクト）に設定されている、特定の動作や状態に関する属性の値を取得するための機能です。これにより、ステートメントが内部的にどのような設定を持っているかを確認できます。

このメソッドの引数int $nameには、取得したい属性を表す定数を指定します。例えば、カーソル名を取得する場合にはPDO::ATTR_CURSOR_NAMEのような定数を指定します。戻り値はmixed型で、指定した属性に設定されている値が返されます。もしその属性が設定されていない場合や、取得できない場合にはfalseが返されるため、戻り値がfalseでないことを確認すると良いでしょう。

サンプルコードでは、まずデータベースへ接続し、次にPDO::prepareメソッドを使ってプリペアドステートメントを作成しています。このとき、PDO::ATTR_CURSOR_NAMEという属性に「product_query_cursor」という名前を設定しています。その後、$stmt->getAttribute(PDO::ATTR_CURSOR_NAME)を実行することで、作成したステートメントに設定したカーソル名を正確に取得し、画面に表示しています。このようにPDOStatement::getAttributeは、プリペアドステートメントの特定の振る舞いや設定値をプログラム上で確認する際に役立つメソッドです。