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

Copy
1<?php
2
3/**
4 * PDO::FETCH_FUNC を使用してデータベースからデータをフェッチし、
5 * カスタム関数で加工するサンプルコードです。
6 *
7 * PDO::FETCH_FUNC は、PDOStatement::fetch() が呼び出された際に、
8 * 指定されたコールバック関数に行の各カラムの値を引数として渡し、
9 * その関数の戻り値をフェッチ結果として返すように指定します。
10 */
11
12try {
13    // 1. SQLiteのインメモリデータベースに接続
14    // これは、実際のファイルシステムを汚さずにデータベース操作を試すための簡単な方法です。
15    $pdo = new PDO('sqlite::memory:');
16    // エラー発生時にPDOExceptionをスローするように設定し、エラーハンドリングを容易にします。
17    $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
18
19    echo "データベース接続成功。\n";
20
21    // 2. テスト用のテーブルを作成し、サンプルデータを挿入
22    $pdo->exec("CREATE TABLE products (id INTEGER PRIMARY KEY, name TEXT, price INTEGER)");
23    $pdo->exec("INSERT INTO products (name, price) VALUES ('apple', 100)");
24    $pdo->exec("INSERT INTO products (name, price) VALUES ('banana', 150)");
25    $pdo->exec("INSERT INTO products (name, price) VALUES ('orange', 120)");
26
27    echo "テストデータ挿入完了。\n\n";
28
29    // 3. PDO::FETCH_FUNC で使用するカスタム関数（コールバック）を定義
30    // この関数は、SELECTクエリで取得される各カラムの値を引数として受け取ります。
31    // 引数の順序と型は、SELECT文で指定したカラムの順序と型に一致させる必要があります。
32    // ここでは、商品名を大文字にし、価格に通貨記号を追加して整形した文字列を返します。
33    $formatProductInfo = function (string $name, int $price): string {
34        return sprintf("商品名: %s, 価格: ¥%d", strtoupper($name), $price);
35    };
36
37    // 4. SELECT クエリを実行し、PDOStatement オブジェクトを取得
38    // productsテーブルからnameとpriceカラムを選択します。
39    $stmt = $pdo->query("SELECT name, price FROM products");
40
41    echo "--- PDO::FETCH_FUNC を使用したデータフェッチ ---" . PHP_EOL;
42
43    // 5. PDOStatement::fetch() メソッドを PDO::FETCH_FUNC とカスタム関数と共に使用
44    // fetch() は、指定された $formatProductInfo 関数が処理して返した値を、
45    // 各行のフェッチ結果として直接返します。
46    while ($formattedData = $stmt->fetch(PDO::FETCH_FUNC, $formatProductInfo)) {
47        echo $formattedData . PHP_EOL;
48    }
49
50    echo "\nフェッチ完了。\n";
51
52} catch (PDOException $e) {
53    // データベース接続またはクエリ実行中にエラーが発生した場合
54    echo "エラーが発生しました: " . $e->getMessage() . "\n";
55    exit(1); // スクリプトをエラー終了
56}
57
58?>

PHPのPDO::FETCH_FUNCは、データベースからデータを取得する際に、各行のデータを開発者が定義したカスタム関数で加工し、その加工結果を直接フェッチ値として受け取るための定数です。この定数はPDOStatement::fetch()メソッドの第1引数に指定し、さらに第2引数にその加工を行うためのコールバック関数を渡して使用します。

PDO::FETCH_FUNCを指定すると、fetch()メソッドは、データベースから取得される行の各カラムの値を、第2引数で指定されたカスタム関数の引数として渡します。カスタム関数の引数の順序と型は、SELECTクエリで指定されたカラムの順序と型に一致させる必要があります。カスタム関数は、これらの引数を使って任意のデータ加工を行い、その結果を戻り値として返します。そして、fetch()メソッドはこのカスタム関数の戻り値を、その行の最終的なフェッチ結果として返します。

これにより、データベースから取得した生のデータに対して、アプリケーション側で事前に定義した形式に整形しながら取得することが可能になり、柔軟なデータ処理を実現します。PDO::FETCH_FUNC定数自体は整数値を持ち、直接引数はありませんが、fetch()メソッドにコールバック関数を指定することでその機能が発揮されます。

Copy
1<?php
2
3/**
4 * PDO::FETCH_FUNC 定数を使用して、データベースから取得したデータをカスタム関数で変換する例
5 *
6 * PDO::FETCH_FUNC は、PDOStatement::fetchAll() や PDOStatement::fetch() メソッドで
7 * 結果をフェッチする際に、各行のデータを変換するためのカスタム関数を指定するために使用されます。
8 * この定数は配列で指定され、その中に PDO::FETCH_FUNC 定数と、適用したい関数名を指定します。
9 */
10
11// データベース接続設定
12// SQLiteのインメモリデータベースを使用し、手軽に試せるようにします。
13try {
14    $pdo = new PDO('sqlite::memory:');
15    // エラーモードを例外に設定し、エラー発生時にPDOExceptionをスローするようにします。
16    $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
17    echo "データベースに接続しました。\n";
18} catch (PDOException $e) {
19    // データベース接続エラーが発生した場合の処理
20    echo "データベース接続エラー: " . $e->getMessage() . "\n";
21    exit(); // スクリプトを終了
22}
23
24// サンプルテーブルの作成
25try {
26    $pdo->exec("CREATE TABLE products (id INTEGER PRIMARY KEY, name TEXT, price INTEGER)");
27    echo "products テーブルを作成しました。\n";
28
29    // サンプルデータの挿入
30    $pdo->exec("INSERT INTO products (name, price) VALUES ('Laptop', 120000)");
31    $pdo->exec("INSERT INTO products (name, price) VALUES ('Mouse', 2500)");
32    $pdo->exec("INSERT INTO products (name, price) VALUES ('Keyboard', 7000)");
33    echo "サンプルデータを挿入しました。\n";
34} catch (PDOException $e) {
35    echo "テーブル作成またはデータ挿入エラー: " . $e->getMessage() . "\n";
36    exit();
37}
38
39// データを変換するためのカスタム関数を定義します。
40// この関数は、PDO::FETCH_FUNC によって呼び出され、引数としてフェッチされた行（連想配列）を受け取ります。
41// 戻り値は、変換後のデータとなります。
42function formatProductForDisplay(array $row): string
43{
44    // 商品名と価格を組み合わせて、表示用の文字列を生成します。
45    // 例: "商品名: Laptop - 価格: 120000円"
46    return "商品名: " . $row['name'] . " - 価格: " . number_format($row['price']) . "円";
47}
48
49// SELECT文を準備し、実行します。
50$stmt = $pdo->prepare("SELECT name, price FROM products");
51$stmt->execute();
52
53// PDO::FETCH_FUNC を使用してデータをフェッチします。
54// fetchAll() メソッドの最初の引数に PDO::FETCH_FUNC を指定し、
55// 2番目の引数に関数名を文字列で渡すことで、取得された各行がこの関数で処理されます。
56echo "\n--- カスタム関数で変換された商品データ ---\n";
57try {
58    $formattedProducts = $stmt->fetchAll(PDO::FETCH_FUNC, 'formatProductForDisplay');
59
60    // 変換された商品データを表示します。
61    foreach ($formattedProducts as $productInfo) {
62        echo $productInfo . "\n";
63    }
64} catch (PDOException $e) {
65    echo "データフェッチエラー: " . $e->getMessage() . "\n";
66}
67
68// PDO オブジェクトがスコープを外れると、接続は自動的に閉じられます。
69// インメモリデータベースは、スクリプト終了時に破棄されます。
70
71?>

PHPのPDO::FETCH_FUNCは、データベースから取得した各行のデータを、あらかじめ定義したカスタム関数で加工するための定数です。これは、PDOStatement::fetchAll()やPDOStatement::fetch()メソッドで結果をフェッチする際に、取得したデータの整形や変換を柔軟に行いたい場合に利用されます。

この定数を使用するには、fetchAll()メソッドなどの最初の引数にPDO::FETCH_FUNCを指定し、続けて2番目の引数としてデータを加工する関数名を文字列で渡します。サンプルコードでは、formatProductForDisplayというカスタム関数が定義されており、この関数がデータベースから取得した各商品の行データを受け取ります。カスタム関数は引数として、フェッチされた1行分のデータ（連想配列）を受け取り、加工後のデータ（この例では表示用の文字列）を戻り値として返します。

結果として、データベースから取得された商品の名前と価格が、formatProductForDisplay関数によって「商品名: Laptop - 価格: 120000円」のような読みやすい形式に変換されて出力されます。PDO::FETCH_FUNC自体は整数値を持つ定数ですが、fetchAllメソッドなどと組み合わせて使うことで、データ取得後の柔軟な処理を可能にします。