【PHP8.x】Pdo\Sqlite::FETCH_FUNC定数の使い方

Copy
1<?php
2
3/**
4 * このスクリプトは、PDO (PHP Data Objects) を使用してSQLiteデータベースからデータを取得し、
5 * 各行の結果をユーザー定義のカスタム関数で処理する方法を示します。
6 *
7 * PHP 8 の機能である PDO::FETCH_FUNC 定数を利用して、
8 * SQLクエリで取得した各行のデータをPHP関数に渡し、整形・加工します。
9 * SQLiteデータベースを使用することで、ファイル作成なしで単体で動作可能です。
10 */
11
12// エラー報告を有効にし、開発中に問題を見つけやすくします。
13ini_set('display_errors', 1);
14ini_set('display_startup_errors', 1);
15error_reporting(E_ALL);
16
17// -----------------------------------------------------------------------------
18// カスタムフェッチ関数
19// -----------------------------------------------------------------------------
20// PDO::FETCH_FUNC を使用する際に、データベースから取得した各行のデータが
21// この関数に引数として渡されます。引数の順番はSELECT文のカラムの順番に一致します。
22// この例では、ユーザーの名前を大文字にし、メールアドレスと結合した文字列を返します。
23//
24// @param string $name  ユーザーの名前（データベースの 'name' カラムから）
25// @param string $email ユーザーのメールアドレス（データベースの 'email' カラムから）
26// @return string 加工されたユーザー情報文字列
27function formatUserData(string $name, string $email): string
28{
29    return strtoupper($name) . ' <' . $email . '>';
30}
31
32try {
33    // -------------------------------------------------------------------------
34    // 1. SQLite インメモリデータベースへの接続を確立
35    // -------------------------------------------------------------------------
36    // ':memory:' を指定することで、一時的なデータベースがメモリ上に作成され、
37    // スクリプト終了時に自動的に破棄されます。
38    $pdo = new PDO('sqlite::memory:');
39
40    // PDOのエラーモードを例外に設定します。
41    // これにより、SQLエラーが発生した際にPDOExceptionがスローされ、
42    // try-catchブロックで適切にエラーを処理できるようになります。
43    $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
44
45    echo "SQLiteインメモリデータベースに接続しました。\n\n";
46
47    // -------------------------------------------------------------------------
48    // 2. テスト用テーブルの作成
49    // -------------------------------------------------------------------------
50    // ユーザー情報を保存するためのシンプルな 'users' テーブルを作成します。
51    // id: 自動インクリメントの主キー
52    // name: ユーザーの名前（NULL不可）
53    // email: ユーザーのメールアドレス（NULL不可、一意制約）
54    $pdo->exec("
55        CREATE TABLE users (
56            id    INTEGER PRIMARY KEY AUTOINCREMENT,
57            name  TEXT    NOT NULL,
58            email TEXT    NOT NULL UNIQUE
59        );
60    ");
61    echo "テーブル 'users' を作成しました。\n\n";
62
63    // -------------------------------------------------------------------------
64    // 3. サンプルデータの挿入
65    // -------------------------------------------------------------------------
66    // プリペアドステートメントを使用して、セキュリティを考慮しつつデータを挿入します。
67    // プレースホルダー (:name, :email) を使うことでSQLインジェクションを防ぎます。
68    $stmt = $pdo->prepare("INSERT INTO users (name, email) VALUES (:name, :email)");
69
70    $stmt->execute([':name' => 'alice', ':email' => 'alice@example.com']);
71    $stmt->execute([':name' => 'bob', ':email' => 'bob@example.com']);
72    $stmt->execute([':name' => 'charlie', ':email' => 'charlie@example.com']);
73
74    echo "サンプルデータを3件挿入しました。\n\n";
75
76    // -------------------------------------------------------------------------
77    // 4. PDO::FETCH_FUNC を使用してデータを取得し、カスタム関数で処理
78    // -------------------------------------------------------------------------
79    // 'users' テーブルから 'name' と 'email' カラムを選択するSQLクエリを実行します。
80    $stmt = $pdo->query("SELECT name, email FROM users");
81
82    // fetchAll() メソッドに PDO::FETCH_FUNC 定数とカスタム関数名を渡します。
83    // これにより、取得された各行のデータ（この場合は 'name' と 'email'）が
84    // 'formatUserData' 関数に引数として渡され、関数の戻り値が結果配列の要素となります。
85    $formattedUsers = $stmt->fetchAll(PDO::FETCH_FUNC, 'formatUserData');
86
87    echo "--- カスタム関数で整形されたユーザーデータ一覧 ---\n";
88    foreach ($formattedUsers as $user) {
89        echo $user . "\n";
90    }
91    echo "--------------------------------------------------\n\n";
92
93} catch (PDOException $e) {
94    // データベース操作中に発生したエラー（例：接続失敗、SQLエラー）をキャッチします。
95    echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
96    // 実際のアプリケーションでは、エラーログへの記録なども検討します。
97} catch (Exception $e) {
98    // その他の予期せぬエラーをキャッチします。
99    echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
100}
101
102?>

このPHPコードは、PDO (PHP Data Objects) を利用してSQLiteデータベースからデータを取得し、PDO::FETCH_FUNC定数を使用して各行の結果をカスタム関数で加工する方法を示しています。PDO::FETCH_FUNCはPHP 8で導入された機能で、データベースからフェッチされる各行に対して、指定されたPHP関数を適用できるようにします。

具体的には、SELECT文で取得される各カラムの値が、引数としてカスタム関数（この例ではformatUserData関数）に渡されます。このカスタム関数は渡されたデータを受け取り、自由に加工して文字列を生成し、その加工された文字列がfetchAll()メソッドの戻り値となる配列の要素として格納されます。

サンプルコードでは、まず一時的なSQLiteデータベースに接続し、usersテーブルを作成してサンプルデータを挿入します。その後、SELECT name, email FROM usersというクエリを実行し、fetchAll(PDO::FETCH_FUNC, 'formatUserData')を使うことで、各ユーザーの名前を大文字にし、メールアドレスと結合した整形済みデータの一覧を簡単に取得・表示しています。この定数を利用することで、データベースからのデータ取得と同時に柔軟なデータ整形処理を一貫して行えるメリットがあります。

Copy
1<?php
2
3/**
4 * PHPのPDO::FETCH_FUNC定数を使用してデータベースからデータを取得し、
5 * 各行をユーザー定義関数で処理するサンプルコードです。
6 *
7 * この定数は、PDOStatement::fetch() や PDOStatement::fetchAll() メソッドに渡すことで、
8 * 結果セットの各行を処理するために特定のコールバック関数を呼び出すようにPDOに指示します。
9 * コールバック関数には、行の各カラムの値が引数として渡されます。
10 *
11 * システムエンジニアを目指す初心者の方は、データベースからのデータ取得と
12 * そのカスタマイズされた処理方法を理解するための基礎として参照してください。
13 */
14
15// データベースファイルのパスを定義します。
16// ':memory:' を使用すると、データベースはメモリ上に作成され、スクリプト終了時に自動的に破棄されます。
17// これにより、ファイル作成やクリーンアップの手間なく、手軽に動作を確認できます。
18$dbFile = ':memory:';
19
20/**
21 * PDO::FETCH_FUNC で各行がフェッチされる際に呼び出されるコールバック関数です。
22 *
23 * この関数は、フェッチされる行の各カラムの値を引数として受け取ります。
24 * 引数の型はデータベースのカラム型に合わせて定義できます（例: int, string）。
25 * この関数の中で、取得したデータを加工したり、特定のビジネスロジックを適用したりできます。
26 *
27 * @param int    $id    ユーザーのユニークID
28 * @param string $name  ユーザーの名前
29 * @param string $email ユーザーのメールアドレス
30 * @return array 処理されたユーザーデータを連想配列として返します。
31 */
32function processUserData(int $id, string $name, string $email): array
33{
34    // コールバック関数が呼び出されたことを示す出力
35    echo "  [コールバック関数が実行されました] ID: {$id}, 名前: {$name}, メール: {$email}\n";
36
37    // データを加工する例: 名前を大文字に変換
38    return [
39        'processed_id' => $id,
40        'processed_name' => strtoupper($name), // 名前の文字列をすべて大文字に変換
41        'processed_email' => $email
42    ];
43}
44
45try {
46    // 1. PDO 接続を確立
47    // SQLite のインメモリデータベースに接続します。
48    $pdo = new PDO("sqlite:$dbFile");
49    // エラーモードを例外に設定し、データベース操作でエラーが発生した場合に
50    // PDOException がスローされるようにします。これにより、エラーハンドリングが容易になります。
51    $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
52
53    echo "データベース接続成功。\n";
54
55    // 2. テスト用のテーブルを作成し、データを挿入
56    // IF NOT EXISTS を使用することで、テーブルが存在しない場合にのみ作成されます。
57    $pdo->exec("
58        CREATE TABLE IF NOT EXISTS users (
59            id INTEGER PRIMARY KEY AUTOINCREMENT,
60            name TEXT NOT NULL,
61            email TEXT NOT NULL UNIQUE
62        );
63    ");
64    echo "テーブル 'users' を作成しました。\n";
65
66    // テストデータを挿入します。
67    $pdo->exec("INSERT INTO users (name, email) VALUES ('Alice', 'alice@example.com');");
68    $pdo->exec("INSERT INTO users (name, email) VALUES ('Bob', 'bob@example.com');");
69    $pdo->exec("INSERT INTO users (name, email) VALUES ('Charlie', 'charlie@example.com');");
70    echo "テストデータを挿入しました。\n";
71
72    // 3. PDO::FETCH_FUNC を使用してデータを取得
73
74    echo "\n--- PDO::FETCH_FUNC を使用してデータをフェッチします ---\n";
75
76    // プリペアドステートメントを作成し、実行
77    $stmt = $pdo->prepare("SELECT id, name, email FROM users ORDER BY id");
78    $stmt->execute();
79
80    echo "fetchAll() メソッドを使用する場合:\n";
81    // fetchAll() に PDO::FETCH_FUNC とコールバック関数名を指定します。
82    // 結果セットの各行に対して `processUserData` 関数が呼び出され、
83    // その関数の戻り値が `allProcessedUsers` 配列の要素となります。
84    $allProcessedUsers = $stmt->fetchAll(PDO::FETCH_FUNC, 'processUserData');
85
86    echo "fetchAll() によって取得・加工された最終データ:\n";
87    print_r($allProcessedUsers);
88
89    // fetch() メソッドを使用する別の例（単一レコードの取得）
90    echo "\nfetch() メソッドを使用する場合 (ID=1 の単一レコード):\n";
91    $stmt = $pdo->prepare("SELECT id, name, email FROM users WHERE id = 1");
92    $stmt->execute();
93    // fetch() に PDO::FETCH_FUNC とコールバック関数名を指定します。
94    // 単一の行に対して `processUserData` 関数が呼び出され、
95    // その関数の戻り値が `singleProcessedUser` の値となります。
96    $singleProcessedUser = $stmt->fetch(PDO::FETCH_FUNC, 'processUserData');
97
98    echo "fetch() によって取得・加工された最終データ:\n";
99    print_r($singleProcessedUser);
100
101} catch (PDOException $e) {
102    // データベース関連のエラー（例: 接続失敗、SQLエラー）をキャッチし、メッセージを出力します。
103    echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
104} catch (Exception $e) {
105    // その他の予期せぬエラー（PDOException 以外）をキャッチします。
106    echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
107}
108
109// インメモリデータベースを使用しているため、明示的なデータベースファイルの削除は不要です。
110echo "\nスクリプトの実行が完了しました。\n";
111
112?>

PHP 8におけるPDO::FETCH_FUNCは、データベースからデータを取得する際に、結果セットの各行をユーザーが定義した関数で処理するための特別な定数です。これはPDOStatement::fetch()やPDOStatement::fetchAll()メソッドの引数として利用され、データベースから取得したデータをそのまま受け取るのではなく、指定されたコールバック関数を通して加工してから受け取ることができます。

この定数自体に引数や戻り値はありませんが、FETCH_FUNCに渡すコールバック関数には、フェッチされる各行のカラム値がそれぞれ引数として渡されます。例えば、ID、名前、メールアドレスといったカラムがあれば、コールバック関数はこれらを引数として受け取り、その関数内でデータを大文字に変換したり、特定の形式に整形したりといった加工処理を行うことができます。加工後のデータは、コールバック関数の戻り値としてfetch()やfetchAll()の最終的な結果に反映されます。

この定数を使うことで、データベースから取得した生のデータに対して、アプリケーション固有のビジネスロジックを適用したり、特定の形式に変換したりする処理を柔軟に組み込むことが可能になります。システムエンジニアを目指す初心者の方にとって、データベースからのデータ取得と、そのデータに対するカスタマイズされた処理方法を学ぶための重要な概念であり、より動的で再利用性の高いデータ処理ロジックを構築する基礎を理解することができます。