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

Copy
1<?php
2
3/**
4 * PDO::PARAM_LOB を使用して大きなバイナリデータをSQLiteデータベースに保存する例。
5 *
6 * この関数は、システムエンジニアを目指す初心者向けに、
7 * PDO::PARAM_LOB 定数の基本的な使い方を簡潔に示します。
8 * LOB (Large Object) は画像や音声などの大きなバイナリデータを指します。
9 */
10function demonstratePdoParamLob(): void
11{
12    // SQLiteデータベースファイル名と、テスト用のダミーデータファイル名を定義
13    $dbFile = 'lob_example.sqlite';
14    $tempDataFile = 'dummy_binary_data.bin';
15
16    try {
17        // 1. PDO (PHP Data Objects) を使用してSQLiteデータベースに接続します。
18        // ファイルが存在しない場合は自動的に作成されます。
19        $pdo = new PDO("sqlite:$dbFile");
20        // エラーモードを例外に設定することで、データベース操作のエラーを捕捉しやすくします。
21        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
22        echo "データベースに接続しました: {$dbFile}\n";
23
24        // 2. LOBデータを格納するためのテーブルを作成します。
25        // id: 主キー、name: データの名前、data: バイナリデータ (SQLiteではBLOB型を使用)
26        $pdo->exec("CREATE TABLE IF NOT EXISTS large_objects (
27            id INTEGER PRIMARY KEY AUTOINCREMENT,
28            name TEXT NOT NULL,
29            data BLOB NOT NULL
30        )");
31        echo "テーブル 'large_objects' が存在しない場合は作成しました。\n";
32
33        // 3. データベースに保存するダミーのバイナリデータを準備します。
34        // テスト用に1KBのダミーデータファイルを作成します。
35        $dummyContent = str_repeat('PHP-LOB-Test', 100); // 約1KBのバイナリデータ
36        file_put_contents($tempDataFile, $dummyContent);
37        echo "ダミーデータファイル '{$tempDataFile}' を作成しました。\n";
38
39        // ファイルからデータを読み込みます。これがデータベースに格納されるLOBデータです。
40        $binaryData = file_get_contents($tempDataFile);
41        if ($binaryData === false) {
42            throw new Exception("ダミーファイルの読み込みに失敗しました: {$tempDataFile}");
43        }
44        $dataName = 'Sample Binary Data';
45
46        // 4. プリペアドステートメントを作成します。
47        // これはSQLインジェクション攻撃を防ぐための安全なデータベース操作方法です。
48        $stmt = $pdo->prepare("INSERT INTO large_objects (name, data) VALUES (:name, :data)");
49
50        // 5. データをバインドし、PDO::PARAM_LOB を使用してバイナリデータを指定します。
51        // ':name' プレースホルダに文字列をバインドします。
52        $stmt->bindValue(':name', $dataName, PDO::PARAM_STR);
53        // ':data' プレースホルダにバイナリデータをバインドします。
54        // PDO::PARAM_LOB は、このデータが大きなバイナリオブジェクトであることをPDOに伝えます。
55        // これにより、PDOはデータを適切に処理し、データベースに保存します。
56        $stmt->bindValue(':data', $binaryData, PDO::PARAM_LOB);
57        echo "データをバインドしました (バイナリデータには PDO::PARAM_LOB を使用)。\n";
58
59        // 6. ステートメントを実行し、データをデータベースに保存します。
60        $stmt->execute();
61        echo "大きなバイナリデータがデータベースに正常に保存されました。\n";
62
63        // オプション: 保存されたデータをデータベースから読み込んで確認します。
64        $retrieveStmt = $pdo->query("SELECT id, name, data FROM large_objects WHERE name = '{$dataName}' LIMIT 1");
65        $retrievedRow = $retrieveStmt->fetch(PDO::FETCH_ASSOC);
66
67        if ($retrievedRow) {
68            echo "保存されたデータを取得しました (ID: {$retrievedRow['id']}, 名前: {$retrievedRow['name']})\n";
69            echo "取得したLOBデータのサイズ: " . strlen($retrievedRow['data']) . "バイト\n";
70            // 必要であれば、取得したバイナリデータをファイルとして保存することも可能です。
71            // file_put_contents('retrieved_binary_data.bin', $retrievedRow['data']);
72            // echo "取得したデータを 'retrieved_binary_data.bin' として保存しました。\n";
73        } else {
74            echo "保存されたデータが見つかりませんでした。\n";
75        }
76
77    } catch (PDOException $e) {
78        // データベース関連のエラーが発生した場合
79        echo "データベースエラー: " . $e->getMessage() . "\n";
80    } catch (Exception $e) {
81        // その他のエラーが発生した場合
82        echo "一般エラー: " . $e->getMessage() . "\n";
83    } finally {
84        // 処理の終了後、作成した一時ファイルとデータベースファイルをクリーンアップします。
85        if (file_exists($tempDataFile)) {
86            unlink($tempDataFile);
87            echo "一時ファイル '{$tempDataFile}' を削除しました。\n";
88        }
89        if (file_exists($dbFile)) {
90            unlink($dbFile);
91            echo "データベースファイル '{$dbFile}' を削除しました。\n";
92        }
93        echo "処理が完了しました。\n";
94    }
95}
96
97// 上記の関数を実行します。
98demonstratePdoParamLob();

このサンプルコードは、PHPでデータベースを扱うためのPDO (PHP Data Objects) という機能を用いて、PDO::PARAM_LOB定数の使い方を具体的に示しています。PDO::PARAM_LOBは、画像や音声ファイルのような大きなバイナリデータ（LOB = Large Object）をデータベースに保存する際に、PDOにデータの種類を正確に伝えるための特別な定数です。この定数自体は引数を取らず、特定の戻り値もありません。

コードではまず、SQLiteデータベースに接続し、バイナリデータを格納するためのテーブルを作成します。次に、テスト用のダミーバイナリデータファイルを準備し、その内容を読み込みます。この読み込んだバイナリデータをデータベースに安全に保存するために、プリペアドステートメントを使用します。

特に注目すべきは、$stmt->bindValue(':data', $binaryData, PDO::PARAM_LOB); の行です。ここでは、保存したいバイナリデータを':data'というプレースホルダに割り当てるとともに、そのデータが大きなバイナリオブジェクト（LOB）であることをPDO::PARAM_LOBで明示的に指定しています。この指定により、PDOはデータを適切に処理し、データベースのBLOB型として正確に格納します。データを保存した後は、データベースから読み出して保存が成功したかを確認し、最後に作成した一時ファイルやデータベースファイルを削除してクリーンアップを行っています。PDO::PARAM_LOBは、大きなバイナリデータを安全かつ効率的にデータベースに格納するために不可欠な要素です。

Copy
1<?php
2
3/**
4 * PDO::PARAM_LOB と PDO::PARAM_STR を使用して、
5 * SQLiteデータベースに文字列とバイナリデータを挿入・取得する例を示します。
6 *
7 * システムエンジニアを目指す初心者向けに、PDOのプリペアドステートメントと
8 * 型バインディングの基本を理解してもらうことを目的としています。
9 */
10function demonstratePdoParamTypes(): void
11{
12    // データベースファイル名を定義
13    // このスクリプトと同じディレクトリに 'test.sqlite' というファイルが作成されます。
14    $dbFile = __DIR__ . '/test.sqlite';
15
16    // PDO (PHP Data Objects) を使用してデータベース操作を行います。
17    try {
18        // 1. PDO接続の確立
19        // 'sqlite:' プレフィックスでSQLiteドライバを指定します。
20        // ファイルが存在しない場合は自動的に作成されます。
21        $pdo = new PDO("sqlite:$dbFile");
22
23        // エラーモードを設定します。
24        // PDO::ERRMODE_EXCEPTION を設定すると、SQLエラーが発生した際にPDOExceptionがスローされ、
25        // try-catchブロックでエラーを捕捉しやすくなります。
26        $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
27        echo "SQLiteデータベースに接続しました。\n";
28
29        // 2. テーブルの作成
30        // 'files' というテーブルを作成します（既に存在する場合は作成しません）。
31        // id: レコードを一意に識別する数値（主キー、自動増加）
32        // name: ファイル名を保存するテキストデータ（文字列）
33        // content: ファイルの内容（バイナリデータ）。SQLiteではBLOB型を使用します。
34        $pdo->exec("
35            CREATE TABLE IF NOT EXISTS files (
36                id INTEGER PRIMARY KEY AUTOINCREMENT,
37                name TEXT NOT NULL,
38                content BLOB
39            )
40        ");
41        echo "テーブル 'files' を作成または確認しました。\n";
42
43        // 3. データの挿入
44        // プリペアドステートメントを使用して、SQLインジェクションのリスクを軽減します。
45        $fileName = "report.txt";
46        // ダミーのファイル内容（ここでは簡単なテキストをバイナリデータとして扱います）
47        // 実際のアプリケーションでは、file_get_contents('path/to/file.pdf') のようにファイルから読み込むことが多いです。
48        $fileContent = "This is a sample report text content for demonstration purposes.";
49
50        $stmt = $pdo->prepare("INSERT INTO files (name, content) VALUES (:name, :content)");
51
52        // パラメータのバインド
53        // bindValueメソッドで、プレースホルダー（:name, :content）に実際の値を関連付けます。
54        // 第3引数でPDO定数を使ってデータの型を明示的に指定することが重要です。
55
56        // 文字列 (TEXT) の場合、PDO::PARAM_STR を指定します。
57        // キーワード 'param_str' に関連する例です。
58        $stmt->bindValue(':name', $fileName, PDO::PARAM_STR);
59
60        // バイナリデータ (BLOB) の場合、PDO::PARAM_LOB を指定します。
61        // リファレンス情報 'PARAM_LOB' に関連する例です。
62        // PHP 8では、bindValueが直接文字列を受け入れるため、大きなBLOBでなければ簡易的に文字列を渡せます。
63        // 非常に大きなBLOBの場合は、ストリームリソースを渡す方がメモリ効率が良いです。
64        $stmt->bindValue(':content', $fileContent, PDO::PARAM_LOB);
65
66        $stmt->execute();
67        echo "データを挿入しました (ファイル名: '$fileName')。\n";
68
69        // 4. データの取得
70        echo "\n--- 挿入されたデータの取得 ---\n";
71        // 挿入したデータをIDで選択し、内容を確認します。
72        $stmt = $pdo->query("SELECT id, name, content FROM files WHERE name = '$fileName'");
73        $result = $stmt->fetch(PDO::FETCH_ASSOC); // 連想配列として結果を取得
74
75        if ($result) {
76            echo "取得ID: " . $result['id'] . "\n";
77            echo "ファイル名: " . $result['name'] . " (PDO::PARAM_STR でバインドされた文字列)\n";
78            echo "コンテンツの長さ: " . strlen($result['content']) . "バイト (PDO::PARAM_LOB でバインドされたバイナリデータ)\n";
79            // BLOBデータは直接出力するとターミナルを乱す可能性があるため、一部のみ表示
80            echo "コンテンツの先頭: " . substr($result['content'], 0, 50) . "...\n";
81        } else {
82            echo "データが見つかりませんでした。\n";
83        }
84
85    } catch (PDOException $e) {
86        // データベース関連のエラーが発生した場合に捕捉します。
87        echo "データベースエラーが発生しました: " . $e->getMessage() . "\n";
88    } catch (Exception $e) {
89        // その他の予期せぬエラーが発生した場合に捕捉します。
90        echo "一般エラーが発生しました: " . $e->getMessage() . "\n";
91    } finally {
92        // データベース接続を閉じる (nullを設定すると接続が閉じられます)
93        // PHPスクリプト終了時には自動的に閉じられることが多いですが、明示的に行うこともできます。
94        $pdo = null;
95        // 例示のためデータベースファイルは削除しません。
96        // 必要であれば、unlink($dbFile); でファイルを削除できます。
97    }
98}
99
100// 関数を実行して、一連のデータベース操作を開始します。
101demonstratePdoParamTypes();
102
103echo "\n実行完了。データベースファイル 'test.sqlite' が作成され、データが挿入されました。\n";
104echo "このファイルはスクリプトと同じディレクトリにあります。\n";
105?>

このPHPサンプルコードは、PDO（PHP Data Objects）を使用してSQLiteデータベースに接続し、文字列データとバイナリデータを安全に挿入・取得する方法を、システムエンジニアを目指す初心者向けに示しています。特に、データベースへデータを渡す際の「型バインディング」という重要な概念を理解することを目的としています。

サンプルコードでは、まずSQLiteデータベースに接続し、ファイル名（文字列）とファイル内容（バイナリ）を保存するテーブルを作成します。次に、SQLインジェクション攻撃を防ぐための「プリペアドステートメント」を使用し、データをデータベースへ挿入します。

ここで中心となるのが、bindValueメソッドの第3引数で渡されるPDO::PARAM_LOBとPDO::PARAM_STRという定数です。PDO::PARAM_LOBは、画像やPDFなどの大きなバイナリデータ（BLOB）を扱う際に、データの型が「バイナリ」であることをデータベースに伝える役割を持ちます。この定数自体には引数や戻り値はありません。一方、PDO::PARAM_STRは、ファイル名のような一般的な文字列データを扱う際に、型が「文字列」であることを示すために使用されます。これも同様に引数や戻り値を持たない定数です。

これらの定数で型を明示的に指定することで、データの破損を防ぎ、データベース操作のセキュリティと正確性を高めることができます。最後に、挿入したデータが正しく取得できることを確認しています。この型バインディングは、安全なデータベースアプリケーション開発の基本です。