【PHP8.x】PDO::__construct()メソッドの使い方

Copy
1<?php
2
3/**
4 * PHP 8のコンストラクタプロパティプロモーションとPDO接続を示すサンプルクラス。
5 *
6 * このクラスは、データベース接続の詳細をプロパティとして保持し、
7 * PDO::__construct メソッドを使用してデータベース接続を確立します。
8 */
9class DatabaseConnector
10{
11    private PDO $pdo; // 確立されたPDOインスタンスを保持するプロパティ
12
13    /**
14     * コンストラクタ。
15     *
16     * PHP 8で導入された「コンストラクタプロパティプロモーション」を使用し、
17     * 引数を直接プライベートプロパティとして定義しながら、PDO接続を確立します。
18     *
19     * @param string      $dsn      データソース名 (例: "mysql:host=localhost;dbname=testdb;charset=utf8mb4")
20     * @param string|null $username データベースユーザー名
21     * @param string|null $password データベースパスワード
22     * @param array|null  $options  PDOドライバオプションの配列
23     */
24    public function __construct(
25        private string $dsn, // private修飾子により、この引数は自動的に同名のプロパティとして定義されます。
26        private ?string $username = null,
27        private ?string $password = null,
28        private ?array $options = null
29    ) {
30        try {
31            // PDO::__construct を使用してデータベースに接続を試みます。
32            // ここで $this->dsn などは、プロパティプロモーションにより自動生成されたプロパティを参照します。
33            $this->pdo = new PDO(
34                $this->dsn,
35                $this->username,
36                $this->password,
37                $this->options
38            );
39
40            // エラーモードを設定し、SQLエラーが発生した場合にPDOExceptionをスローさせることで、
41            // エラーハンドリングを容易にします。
42            $this->pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
43
44        } catch (PDOException $e) {
45            // データベース接続に失敗した場合、エラーメッセージを表示してスクリプトを終了します。
46            // 実際のアプリケーションでは、エラーログに記録し、ユーザーには安全なエラーメッセージを表示するべきです。
47            exit("データベース接続エラー: " . $e->getMessage());
48        }
49    }
50
51    /**
52     * 確立されたPDO接続インスタンスを返します。
53     * これにより、このクラスの外部からデータベース操作を行えるようになります。
54     *
55     * @return PDO 確立されたPDO接続インスタンス
56     */
57    public function getConnection(): PDO
58    {
59        return $this->pdo;
60    }
61}
62
63// --- サンプル使用例 ---
64// 実際のアプリケーションでは、これらの接続情報は設定ファイルなどから安全に読み込むべきです。
65$dsn = "mysql:host=localhost;dbname=testdb;charset=utf8mb4"; // ご自身のデータベース情報に置き換えてください
66$username = "root";                                      // ご自身のデータベースユーザー名に置き換えてください
67$password = "your_password";                             // ご自身のデータベースパスワードに置き換えてください
68$options = [
69    PDO::ATTR_EMULATE_PREPARES   => false, // プリペアドステートメントのエミュレーションを無効にする (推奨)
70    PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC, // デフォルトのフェッチモードを連想配列に設定
71];
72
73try {
74    // DatabaseConnectorクラスのインスタンスを作成すると、
75    // そのコンストラクタ内でPDO::__constructが呼び出され、データベース接続が確立されます。
76    $dbConnector = new DatabaseConnector($dsn, $username, $password, $options);
77    echo "データベースに正常に接続されました！\n";
78
79    // 接続されたPDOインスタンスを取得し、データベース操作に使用できます。
80    // $pdo = $dbConnector->getConnection();
81    // $stmt = $pdo->query("SELECT 'Hello, Database!' as message");
82    // $result = $stmt->fetch();
83    // echo "メッセージ: " . $result['message'] . "\n";
84
85} catch (Throwable $e) {
86    // DatabaseConnectorのコンストラクタ内でPDOExceptionは捕捉されるため、
87    // ここは通常、DatabaseConnectorクラス自体以外の予期せぬエラーを捕捉します。
88    echo "アプリケーション実行中に予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
89}

このPHPサンプルコードは、PHP 8で導入された「コンストラクタプロパティプロモーション」という機能と、データベース接続の基本である PDO::__construct メソッドの使い方を、システムエンジニアを目指す初心者の方にも分かりやすく解説しています。

DatabaseConnector クラスは、データベースへの接続を管理する専用のクラスです。その __construct メソッド（コンストラクタ）では、PHP 8の新機能「コンストラクタプロパティプロモーション」を活用しています。これは、コンストラクタの引数に private などのアクセス修飾子を付けることで、その引数が自動的に同じ名前のプライベートプロパティとして定義される便利な機能です。これにより、コードの記述量を減らし、データベース接続に必要な情報を簡潔に保持できます。

コンストラクタの内部で呼び出される PDO::__construct は、実際にデータベース接続を確立する重要なメソッドです。引数 $dsn にはデータベースの種類や接続先を、$username と $password には認証情報を、$options にはPDOの動作に関する詳細な設定をそれぞれ渡します。このメソッドは、データベースへの接続が成功すればPDOインスタンスを作成し、失敗すれば PDOException を発生させます。サンプルコードでは try-catch ブロックを使い、接続エラーが起きた際に安全に処理を停止するよう実装されています。

getConnection() メソッドは、確立されたPDO接続インスタンスをクラスの外部に提供します。これにより、他の部分からデータベース操作（データの読み書きなど）を行えるようになります。サンプルコードの最後の部分では、DatabaseConnector クラスのインスタンスを作成するだけでデータベース接続が完了し、その後のデータベース操作に利用できる一連の流れが示されています。