【PHP8.x】SQLite3::PRAGMA定数の使い方

Copy
1<?php
2
3/**
4 * SQLite3データベースでPRAGMAステートメントを設定するサンプル関数です。
5 *
6 * この関数は、指定されたパスのSQLite3データベースに接続し、
7 * データベース設定を変更するためのPRAGMAステートメントを実行します。
8 * 例えば、外部キー制約を有効にする 'PRAGMA foreign_keys = ON;' などがあります。
9 *
10 * キーワード「pragma once」に関連して、データベース接続後に一度だけ設定されることが多い
11 * PRAGMAステートメントの実行方法を示します。
12 *
13 * @param string $dbPath データベースファイルのパス。
14 * @return void
15 */
16function configureSqlitePragma(string $dbPath): void
17{
18    $sqlite = null; // SQLite3オブジェクトを初期化
19
20    try {
21        // 1. SQLite3データベースに接続します。
22        // 指定されたパスにファイルが存在しない場合、新しいデータベースファイルが作成されます。
23        $sqlite = new SQLite3($dbPath);
24        echo "データベース '{$dbPath}' に接続しました。\n";
25
26        // 2. PRAGMAステートメントを実行します。
27        // ここでは、外部キー制約を有効にする 'PRAGMA foreign_keys = ON;' を実行します。
28        // この設定は通常、データベース接続が確立された後、一度だけ行われます。
29        $pragmaStatement = "PRAGMA foreign_keys = ON;";
30        
31        // exec() メソッドは、結果セットを返さないSQLステートメント（例: INSERT, UPDATE, PRAGMA）に使用されます。
32        $sqlite->exec($pragmaStatement);
33        echo "PRAGMAステートメント '{$pragmaStatement}' を実行しました。\n";
34
35        // (オプション) 設定が正しく適用されたかを確認するPRAGMA
36        // querySingle() メソッドは、単一の値を返すクエリ（例: 設定値の取得）に使用されます。
37        $result = $sqlite->querySingle("PRAGMA foreign_keys;");
38        echo "現在の 'foreign_keys' 設定: " . ($result ? "ON" : "OFF") . "\n";
39
40        // ここに、他のデータベース操作（テーブル作成、データの挿入など）を追加できます。
41
42    } catch (Exception $e) {
43        // データベース接続やPRAGMA実行中にエラーが発生した場合の処理
44        error_log("SQLite3操作中にエラーが発生しました: " . $e->getMessage());
45        echo "エラーが発生しました: " . $e->getMessage() . "\n";
46    } finally {
47        // データベース接続が開いている場合、必ず閉じます。
48        if ($sqlite instanceof SQLite3) {
49            $sqlite->close();
50            echo "データベース接続を閉じました。\n";
51        }
52    }
53}
54
55// ----------------------------------------------------
56// サンプルコードの実行部分
57// ----------------------------------------------------
58
59// データベースファイル名を定義
60$databaseFile = 'my_sample_database.db';
61
62// 関数を実行し、PRAGMAステートメントを設定
63configureSqlitePragma($databaseFile);
64
65// 実行後に作成されたデータベースファイルを削除する（オプション）
66// 開発やテスト環境で一時ファイルとして使用した場合に便利です。
67// if (file_exists($databaseFile)) {
68//     unlink($databaseFile);
69//     echo "データベースファイル '{$databaseFile}' を削除しました。\n";
70// }

このサンプルコードは、PHPのSQLite3エクステンションを使用して、SQLite3データベースのPRAGMAステートメントを設定する方法を紹介しています。PRAGMAは、データベースの動作や設定を変更するためのSQLコマンドであり、PHPのSQLite3クラスを通じて実行できます。

configureSqlitePragma関数は、データベースファイルのパスを指定する$dbPathという文字列型の引数を受け取ります。この関数は、SQLite3クラスのインスタンスを生成してデータベースに接続し、指定されたPRAGMAステートメントを実行します。

具体的には、PRAGMA foreign_keys = ON;というステートメントをSQLite3::exec()メソッドに渡し、外部キー制約を有効にしています。この種のPRAGMA設定は、データベース接続後に一度だけ実行されることが多く、キーワード「pragma once」の概念に通じます。SQLite3::exec()メソッドは結果セットを返さないSQLステートメントに使用されるため、この関数の戻り値はvoidであり、何も返しません。

また、データベース操作中のエラーを適切に処理し、使用後にデータベース接続を閉じるためのtry-catch-finallyブロックが実装されており、堅牢なプログラミングの基礎を示しています。

Copy
1<?php
2
3// Composerのオートロードファイルを読み込み、必要なライブラリが利用できるようにします。
4// このサンプルコードを実行する前に、プロジェクトのルートディレクトリで以下のコマンドを実行してください。
5// composer require pragmarx/google2fa-qrcode
6require_once 'vendor/autoload.php';
7
8use PragmaRX\Google2FAQRCode\Google2FA;
9
10/**
11 * Google Authenticatorを使用した二段階認証（2FA）のためのQRコードを生成します。
12 *
13 * この関数は、指定された組織名とユーザー名に基づいて、
14 * Google Authenticatorアプリでスキャンするための秘密鍵を生成し、
15 * その秘密鍵を含むQRコードのSVG（Scalable Vector Graphics）表現を標準出力に出力します。
16 * 生成されたSVGコードをHTMLファイルとして保存し、ウェブブラウザで開くことで、
17 * QRコードを目視確認し、Google Authenticatorアプリでスキャンできます。
18 * このコードは、ウェブサーバーなしでCLI (コマンドラインインターフェース) 環境で直接実行可能です。
19 *
20 * @param string $companyName 二段階認証を設定する組織またはアプリケーションの名前。
21 *                            Google Authenticatorアプリに表示されます。
22 *                            例: 'MyCompanyApp'
23 * @param string $userName 二段階認証を設定するユーザーの識別子。
24 *                         Google Authenticatorアプリに表示されます。
25 *                         例: 'user@example.com'
26 * @return void
27 */
28function generateTwoFactorAuthQrCode(string $companyName, string $userName): void
29{
30    // PragmaRX\Google2FAQRCode\Google2FA クラスのインスタンスを作成します。
31    // このライブラリは、秘密鍵の生成とQRコードSVGの生成を容易にします。
32    $google2fa = new Google2FA();
33    
34    // Google Authenticator用の秘密鍵を生成します。
35    // この鍵は、ユーザーごとに一意に生成され、安全に保管される必要があります。
36    $secretKey = $google2fa->generateSecretKey();
37
38    echo "生成された秘密鍵: " . $secretKey . PHP_EOL;
39
40    // Google AuthenticatorアプリがスキャンできるQRコードのSVG表現を生成します。
41    // このSVGには、組織名、ユーザー名、そして生成された秘密鍵がエンコードされています。
42    $qrCodeSvg = $google2fa->getQRCodeInline(
43        $companyName,
44        $userName,
45        $secretKey
46    );
47
48    echo PHP_EOL;
49    echo "--- Google Authenticator QR コード (SVG) ---" . PHP_EOL;
50    echo "以下のSVGコードは、QRコードリーダーでスキャン可能です。" . PHP_EOL;
51    echo "HTMLファイルとして保存し、ブラウザで開いてQRコードを表示してください。" . PHP_EOL;
52    echo "例: echo \$qrCodeSvg > qrcode.html && open qrcode.html" . PHP_EOL;
53    echo $qrCodeSvg . PHP_EOL;
54    echo "------------------------------------------" . PHP_EOL;
55    echo "この秘密鍵とQRコードをGoogle Authenticatorアプリに登録して、二段階認証を設定してください。" . PHP_EOL;
56}
57
58// サンプルとして、'MyAwesomeApp' という組織名と 'newuser@example.com' というユーザー名で
59// 二段階認証のQRコード生成関数を実行します。
60// 実際のシステムでは、これらの値はデータベースやユーザー入力から動的に取得されます。
61generateTwoFactorAuthQrCode('MyAwesomeApp', 'newuser@example.com');

このPHPサンプルコードは、PragmaRX/Google2FAQRCodeライブラリを活用し、Google Authenticatorのようなアプリで利用する二段階認証（2FA）用のQRコードを生成する手順を示しています。

generateTwoFactorAuthQrCode関数は、二段階認証を設定する組織名とユーザー名を引数として受け取ります。$companyName引数にはGoogle Authenticatorアプリに表示される組織の名前を、$userName引数には同じくアプリに表示されるユーザーの識別子を指定します。この関数は内部で、ユーザーごとに一意の秘密鍵を生成し、その秘密鍵、組織名、ユーザー名をエンコードしたQRコードのSVG（Scalable Vector Graphics）データを生成します。

関数には戻り値がなく（void）、生成された秘密鍵とQRコードのSVG表現を標準出力に出力します。出力されたSVGコードは、HTMLファイルとして保存し、ウェブブラウザで開くことでQRコードを視覚的に確認できます。これにより、Google AuthenticatorアプリでQRコードをスキャンし、二段階認証を簡単に設定することが可能になります。このコードは、ウェブサーバーを必要とせず、コマンドラインインターフェース（CLI）環境で直接実行できるため、開発やテストの際に手軽に利用できます。