【PHP8.x】__constructメソッドの使い方

Copy
1<?php
2
3// SQLite3 データベース接続を開きます。
4// ':memory:' はデータベースをメモリ上に作成し、スクリプト終了時に自動的に破棄されます。
5$sqlite3 = new SQLite3(':memory:');
6
7// データベース接続の成功を確認します。
8// 接続に失敗した場合は、エラーメッセージを出力してスクリプトを終了します。
9if (!$sqlite3) {
10    exit('Failed to open SQLite3 database.');
11}
12
13// プリペアドステートメントで使用するテーブルが存在しない場合、作成します。
14// これは `SQLite3Stmt::__construct` の直接のデモではありませんが、
15// 後続のプリペアドステートメントが有効になるための一般的な準備ステップです。
16$createTableSql = 'CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT NOT NULL)';
17if (!$sqlite3->exec($createTableSql)) {
18    exit('Error creating table: ' . $sqlite3->lastErrorMsg());
19}
20
21// プリペアドステートメントとして準備するSQLクエリを定義します。
22// この例では、`users` テーブルにデータを挿入するクエリを使用します。
23// `?` はプレースホルダで、後で実際の値がバインドされます。
24$insertQuery = 'INSERT INTO users (name) VALUES (?)';
25
26// SQLite3Stmt::__construct メソッドを使用して、プリペアドステートメントを準備します。
27// 引数:
28// 1. `SQLite3 $sqlite3`: 開いているデータベース接続オブジェクト。
29// 2. `string $query`: データベースエンジンで準備（コンパイル）するSQLクエリ文字列。
30try {
31    // コンストラクタが正常に実行されると、`SQLite3Stmt` オブジェクトが生成されます。
32    // これにより、SQLクエリが解析され、実行可能な状態になります。
33    $stmt = new SQLite3Stmt($sqlite3, $insertQuery);
34
35    // ここでは `$stmt` オブジェクトが正常に作成されたことを示すだけで、
36    // その後の値のバインドや実行は、`__construct` のデモンストレーション範囲外のため省略します。
37    // 例:
38    // $stmt->bindValue(1, 'Alice', SQLITE3_TEXT);
39    // $stmt->execute();
40    // $stmt->close(); // プリペアドステートメントを閉じ、リソースを解放します
41
42} catch (Exception $e) {
43    // `SQLite3Stmt::__construct` が失敗した場合（例: 無効なSQL構文エラーなど）、
44    // PHPはここで例外をスローし、捕捉されます。
45    exit('Error preparing statement: ' . $e->getMessage() . ' (SQLite error details: ' . $sqlite3->lastErrorMsg() . ')');
46} finally {
47    // スクリプトの終了前に、開いたデータベース接続を必ず閉じます。
48    $sqlite3->close();
49}

このサンプルコードは、PHPでSQLite3データベースを操作する際に、SQLインジェクション対策や効率的なクエリ実行のために使用される「プリペアドステートメント」を準備するSQLite3Stmt::__constructメソッドの利用方法を示しています。

まず、:memory:を指定してメモリ上にSQLite3データベースを一時的に開き、usersテーブルを作成しています。これはプリペアドステートメントを実行するための準備です。

次に、INSERT INTO users (name) VALUES (?)というSQLクエリを定義しています。ここで使われている?はプレースホルダと呼ばれ、後から実際の値を安全にバインドするために利用されます。

SQLite3Stmt::__constructメソッドは、この定義したSQLクエリをデータベースエンジンに渡して準備（コンパイル）させる役割を担います。 引数として、SQLite3 $sqlite3には開いているデータベース接続オブジェクトを、string $queryには準備したいSQLクエリ文字列を渡します。このメソッド自体はオブジェクトを直接返すのではなく、newキーワードと共に使用することでSQLite3Stmtオブジェクトを生成します。

コンストラクタが正常に実行されると、$stmtというSQLite3Stmtオブジェクトが作成されます。このオブジェクトは、渡されたSQLクエリがデータベースによって解析され、実行可能な状態であることを意味します。ただし、この時点ではまだSQLは実行されていません。実際の値のバインドやクエリの実行は、この後にbindValueやexecuteといった別のメソッドを使用して行われます。

もしSQLクエリの構文に誤りがあるなど、プリペアドステートメントの準備に失敗した場合は、try-catchブロックで捕捉される例外がスローされます。最後に、開いたデータベース接続をclose()メソッドで確実に閉じ、リソースを解放しています。

Copy
1<?php
2
3/**
4 * SQLite3 データベース操作を管理するシンプルなクラスです。
5 * PHP 8 のコンストラクタプロパティプロモーション機能を使用して、
6 * 依存する SQLite3 オブジェクトを簡潔にプロパティとして初期化します。
7 */
8class DatabaseManager
9{
10    // コンストラクタプロパティプロモーションを使用。
11    // 引数として受け取った SQLite3 オブジェクトが自動的にプライベートプロパティ $db として設定されます。
12    // これにより、プロパティの宣言とコンストラクタ内での代入を省略できます。
13    public function __construct(private SQLite3 $db)
14    {
15        // ここでは追加の初期化は不要です。
16        // $db プロパティはすでに初期化されています。
17    }
18
19    /**
20     * テーブルを作成します。
21     */
22    public function createTable(): void
23    {
24        $query = 'CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY, name TEXT)';
25        $this->db->exec($query);
26        echo "テーブル 'users' が作成されたか、既に存在します。\n";
27    }
28
29    /**
30     * データを挿入します。
31     * SQLite3Stmt の利用を意識し、プリペアドステートメントを使用します。
32     */
33    public function insertData(string $name): void
34    {
35        // プリペアドステートメントを作成します。
36        // ここで内部的に SQLite3Stmt のインスタンスが生成されます。
37        $stmt = $this->db->prepare('INSERT INTO users (name) VALUES (?)');
38        
39        // プレースホルダに値をバインドします。
40        $stmt->bindValue(1, $name, SQLITE3_TEXT);
41        
42        // ステートメントを実行します。
43        $stmt->execute();
44        
45        // ステートメントをクローズします。
46        $stmt->close();
47        echo "'{$name}' が挿入されました。\n";
48    }
49
50    /**
51     * すべてのデータを取得して表示します。
52     */
53    public function selectAllData(): void
54    {
55        $result = $this->db->query('SELECT id, name FROM users');
56        echo "--- ユーザーリスト ---\n";
57        while ($row = $result->fetchArray(SQLITE3_ASSOC)) {
58            echo "ID: " . $row['id'] . ", 名前: " . $row['name'] . "\n";
59        }
60        echo "--------------------\n";
61    }
62
63    /**
64     * デストラクタ: データベース接続を閉じます。
65     */
66    public function __destruct()
67    {
68        $this->db->close();
69        echo "データベース接続が閉じられました。\n";
70    }
71}
72
73// --- 単体で動作させるためのコード ---
74
75try {
76    // 1. インメモリデータベースを開きます。
77    // これはテスト目的で、実際のアプリケーションではファイルパスを指定します。
78    $sqliteDb = new SQLite3(':memory:');
79
80    // 2. DatabaseManager クラスのインスタンスを作成します。
81    // PHP 8 のコンストラクタプロパティプロモーションにより、
82    // $sqliteDb オブジェクトが DatabaseManager の $db プロパティとして自動的に設定されます。
83    $manager = new DatabaseManager($sqliteDb);
84
85    // 3. データベース操作を実行します。
86    $manager->createTable();
87    $manager->insertData('Alice');
88    $manager->insertData('Bob');
89    $manager->selectAllData();
90
91    // もう一度データを挿入し、確認
92    $manager->insertData('Charlie');
93    $manager->selectAllData();
94
95} catch (Exception $e) {
96    echo "エラーが発生しました: " . $e->getMessage() . "\n";
97}
98
99?>

このPHPコードは、PHP 8におけるSQLite3データベース操作を簡潔に管理するDatabaseManagerクラスの具体的な例です。特に注目すべきは、クラスの__constructメソッドで採用されている「コンストラクタプロパティプロモーション」というPHP 8の新機能です。これにより、SQLite3オブジェクト（データベース接続を管理するインスタンス）を引数として受け取りながら、同時にprivate $dbというプライベートプロパティとして宣言・初期化する作業を一行で記述でき、コードの記述量を大幅に削減しています。このコンストラクタは戻り値を持ちません。

createTableメソッドはデータベースに新しいテーブルを作成し、insertDataメソッドはデータを安全に挿入します。insertDataでは、SQLインジェクション攻撃を防ぐためにプリペアドステートメントが使用されており、$this->db->prepare()を呼び出すことで内部的にSQLite3Stmtのインスタンスが生成されます。このSQLite3Stmtのコンストラクタは、データベース接続と実行するSQLクエリを引数にとりますが、直接記述することなくprepareメソッドが内部で処理し、戻り値はありません。その後、bindValueで値を設定し、executeでクエリを実行します。selectAllDataメソッドはテーブルからすべてのデータを取得して表示し、__destructメソッドはオブジェクトが破棄される際にデータベース接続を自動的に閉じます。

コードの実行部分では、一時的なインメモリのSQLite3データベースを作成し、その接続をDatabaseManagerのインスタンスに渡して、テーブル作成、データ挿入、データ取得といった一連のデータベース操作を行っています。