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

Copy
1<?php
2
3class MyDatabase
4{
5    private SQLite3 $db;
6
7    /**
8     * データベース接続を確立します。
9     *
10     * @param string $dbPath データベースファイルのパス
11     */
12    public function __construct(private string $dbPath)
13    {
14        try {
15            $this->db = new SQLite3($this->dbPath);
16        } catch (SQLite3Exception $e) {
17            // SQLite3Exception をキャッチして、より具体的な例外をthrowする
18            throw new Exception("データベース接続に失敗しました: " . $e->getMessage(), $e->getCode(), $e);
19        }
20    }
21
22    /**
23     * データベース接続を閉じます。
24     */
25    public function __destruct()
26    {
27        if (isset($this->db)) {
28            $this->db->close();
29        }
30    }
31
32    /**
33     * ユーザーをデータベースに登録する
34     *
35     * @param string $username
36     * @param string $email
37     * @return bool
38     * @throws Exception
39     */
40    public function registerUser(string $username, string $email): bool
41    {
42        try {
43            $stmt = $this->db->prepare('INSERT INTO users (username, email) VALUES (:username, :email)');
44            $stmt->bindValue(':username', $username, SQLITE3_TEXT);
45            $stmt->bindValue(':email', $email, SQLITE3_TEXT);
46
47            $result = $stmt->execute();
48
49            return $result !== false;
50        } catch (Exception $e) {
51            throw new Exception("ユーザー登録に失敗しました: " . $e->getMessage(), $e->getCode(), $e);
52        }
53    }
54}
55
56// データベースのパス
57$dbPath = 'my_database.db';
58
59// MyDatabaseクラスのインスタンスを作成
60try {
61    $db = new MyDatabase($dbPath);
62
63    // ユーザー登録の実行
64    $registrationSuccess = $db->registerUser('testuser', 'test@example.com');
65
66    if ($registrationSuccess) {
67        echo "ユーザー登録に成功しました。\n";
68    } else {
69        echo "ユーザー登録に失敗しました。\n";
70    }
71
72} catch (Exception $e) {
73    echo "エラーが発生しました: " . $e->getMessage() . "\n";
74}
75
76?>

このPHPのサンプルコードは、SQLite3データベースへの接続を管理するMyDatabaseクラスを示しています。特に、SQLite3Exceptionクラスのコンストラクタ(__construct)の役割と、データベース接続時の例外処理に焦点を当てています。

MyDatabaseクラスのコンストラクタは、データベースファイルのパスを受け取り、SQLite3データベースへの接続を確立します。ここでは、PHP 8の機能であるプロパティプロモーションを利用して、コンストラクタの引数$dbPathをクラスのprivateプロパティとして直接定義しています。これにより、コードが簡潔になります。

データベース接続時にSQLite3Exceptionが発生した場合、catchブロックでそれをキャッチし、より具体的な例外(Exception)をスローすることで、エラー処理を改善しています。これは、上位の呼び出し元に対して、より詳細なエラー情報を提供するためです。Exceptionコンストラクタの第三引数に $e を渡すことで、元の例外情報（スタックトレースなど）を引き継ぐことができます。

コンストラクタの引数は以下の通りです。

• $message: 例外メッセージ（省略可能）
• $code: 例外コード（省略可能）
• $previous: 以前の例外（省略可能）。例外が別の例外の結果としてスローされた場合に、前の例外を渡します。

__construct はコンストラクタであるため、戻り値はありません。

registerUserメソッドは、データベースに新しいユーザーを登録する機能を提供します。プリペアドステートメントを使用することで、SQLインジェクション攻撃を防ぎます。

サンプルコード全体は、データベース接続の確立、例外処理、および基本的なデータベース操作の方法を示しており、システムエンジニアを目指す初心者にとって、実践的な学習教材となります。

Copy
1<?php
2
3class CustomSQLite3Exception extends SQLite3Exception
4{
5    public function __construct(string $message = "", int $code = 0, ?Throwable $previous = null)
6    {
7        // 親クラスのコンストラクタを呼び出す
8        parent::__construct($message, $code, $previous);
9
10        // カスタム処理を追加する場合、ここに記述する
11        // 例：ログ出力など
12    }
13
14    public function customMethod(): string
15    {
16        return "Custom exception method called.";
17    }
18}
19
20// 例外を発生させる例
21try {
22    throw new CustomSQLite3Exception("Custom SQLite3 exception occurred.", 123);
23} catch (CustomSQLite3Exception $e) {
24    echo "Caught exception: " . $e->getMessage() . "\n";
25    echo "Code: " . $e->getCode() . "\n";
26    echo $e->customMethod() . "\n";
27}

このサンプルコードは、PHP 8におけるSQLite3Exceptionクラスを拡張したカスタム例外クラスCustomSQLite3Exceptionのコンストラクタ(__construct)の利用例を示しています。

SQLite3Exceptionは、SQLite3データベース操作で発生した例外を表すクラスです。CustomSQLite3Exceptionは、このクラスを継承することで、独自の例外処理を実装できます。

コンストラクタ__constructは、例外オブジェクトの初期化を行う特別なメソッドです。引数として、例外メッセージ($message: string, デフォルトは空文字列)、例外コード($code: int, デフォルトは0)、前の例外オブジェクト($previous: ?Throwable, デフォルトはnull)を受け取ります。

parent::__construct($message, $code, $previous);の行では、親クラス(SQLite3Exception)のコンストラクタを呼び出しています。これは、親クラスが持つ例外メッセージやコードなどの初期化処理を確実に行うために重要です。

// カスタム処理を追加する場合、ここに記述するの部分には、独自の例外処理を記述できます。例えば、エラーログへの出力などを行うことが考えられます。

サンプルコードでは、customMethodという独自のメソッドを追加し、例外発生時にこのメソッドを呼び出す例を示しています。

try-catchブロックは、例外を捕捉し、処理するための構文です。CustomSQLite3Exceptionが発生した場合、catchブロックで例外オブジェクトを受け取り、getMessage()で例外メッセージ、getCode()で例外コードを取得しています。また、customMethod()を呼び出して、カスタム例外クラスに追加したメソッドを実行しています。