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

Copy
1<?php
2
3// このコードは、PHPの組み込みクラスであるExceptionのコンストラクタ（__constructメソッド）の使用方法を示します。
4// コンストラクタは、`new`キーワードを使ってクラスの新しいインスタンスが作成される際に自動的に呼び出される特別なメソッドです。
5
6try {
7    // `new Exception(...)` はExceptionクラスの新しいインスタンスを作成し、
8    // その際に、指定された引数（メッセージとコード）で内部的に__constructメソッドを呼び出します。
9    // 引数: string $message = "", int $code = 0, ?Throwable $previous = null
10    throw new Exception("ユーザー情報の取得に失敗しました。", 1001);
11
12} catch (Exception $e) {
13    // 例外がスローされると、対応するcatchブロックが実行されます。
14    // `$e`オブジェクトには、__constructメソッドで設定された情報が含まれています。
15
16    echo "例外をキャッチしました！\n";
17    echo "メッセージ: " . $e->getMessage() . "\n"; // コンストラクタで指定したメッセージを取得
18    echo "コード: " . $e->getCode() . "\n";     // コンストラクタで指定したコードを取得
19    echo "ファイル: " . $e->getFile() . "\n";   // 例外が発生したファイルパス
20    echo "行: " . $e->getLine() . "\n";     // 例外が発生したコードの行数
21}
22
23// このサンプルコードは、__constructメソッドがどのようにExceptionオブジェクトを初期化し、
24// その情報が`try-catch`ブロックでどのように利用されるかを示しています。

PHPのExceptionクラスは、プログラム実行中に発生した予期せぬ問題（例外）を扱うための基本的なクラスです。__constructメソッドは、このExceptionクラスの新しいインスタンスを作成する際に、newキーワードを使って自動的に呼び出される特別な初期化メソッド（コンストラクタ）です。

このコンストラクタは、作成される例外オブジェクトに具体的な情報を設定するために使用されます。$message引数には、エラーの内容を説明する文字列を指定します。このメッセージは、後でgetMessage()メソッドで取得できます。$code引数には、エラーの種類を一意に識別するための数値コードを整数で指定し、これはgetCode()メソッドで取得可能です。また、$previous引数には、現在の例外の発生元となった別の例外オブジェクトを指定でき、例外の連鎖を表現する際に利用されます。__constructメソッド自体は、オブジェクトを初期化する役割のみを持ち、特定の値を返しません（戻り値なし）。

サンプルコードでは、throw new Exception("...", 1001);のように記述することで、__constructメソッドが呼び出され、指定されたメッセージとコードでExceptionオブジェクトが初期化されます。この初期化された例外オブジェクトはtry-catchブロックで捕捉され、$e->getMessage()や$e->getCode()といったメソッドを通じて、コンストラクタで設定された情報を取り出し、適切にエラー処理を行うことができるのです。このように、__constructメソッドは例外オブジェクトに詳細な情報を持たせる上で重要な役割を果たします。

Copy
1<?php
2
3/**
4 * PHP 8のコンストラクタプロパティプロモーションとException::__constructを組み合わせたカスタム例外の例。
5 * 通常のExceptionが持つ情報に加え、独自のプロパティ（ここでは`customData`）を簡潔に定義できます。
6 */
7class MyCustomException extends Exception
8{
9    /**
10     * コンストラクタプロパティプロモーションを使用して、
11     * この例外に固有の追加データ`customData`を定義します。
12     * `public readonly`は、外部から読み取り可能だが変更不可なプロパティであることを示します。
13     *
14     * @param string $message エラーメッセージ
15     * @param int $code エラーコード
16     * @param Throwable|null $previous 前の例外（例外チェーン用）
17     * @param string $customData この例外に付随する追加情報
18     */
19    public function __construct(
20        string $message = "",
21        int $code = 0,
22        ?Throwable $previous = null,
23        public readonly string $customData = "デフォルトの追加情報" // PHP 8のコンストラクタプロパティプロモーション
24    ) {
25        // 親クラスであるExceptionのコンストラクタを呼び出し、
26        // 標準のエラー情報（メッセージ、コード、前の例外）を初期化します。
27        parent::__construct($message, $code, $previous);
28    }
29}
30
31/**
32 * MyCustomExceptionを使用する関数の例。
33 * 引数の型が想定と異なる場合にカスタム例外をスローします。
34 *
35 * @param mixed $value チェックする値
36 * @return string 処理結果メッセージ
37 * @throws MyCustomException 値が文字列でない場合
38 */
39function processValue(mixed $value): string
40{
41    if (!is_string($value)) {
42        // 引数が文字列ではない場合、MyCustomExceptionをスローします。
43        // コンストラクタプロパティプロモーションで定義した`customData`も同時に設定しています。
44        throw new MyCustomException(
45            message: "無効な入力データです。",
46            code: 1001,
47            customData: "予期される型: string, 実際の型: " . gettype($value)
48        );
49    }
50    return "値が正常に処理されました: " . $value;
51}
52
53// --- カスタム例外の動作例 ---
54
55// 1. 意図的に例外を発生させるケース
56try {
57    echo processValue(123) . "\n"; // 文字列ではない数値を渡す
58} catch (MyCustomException $e) {
59    echo "--- MyCustomExceptionをキャッチしました ---\n";
60    echo "メッセージ: " . $e->getMessage() . "\n";
61    echo "コード: " . $e->getCode() . "\n";
62    echo "ファイル: " . $e->getFile() . "\n";
63    echo "行: " . $e->getLine() . "\n";
64    // コンストラクタプロパティプロモーションで定義したカスタムデータにアクセス
65    echo "追加情報: " . $e->customData . "\n";
66} catch (Exception $e) {
67    // その他の一般的な例外をキャッチ（ここでは到達しないはず）
68    echo "--- 一般的なExceptionをキャッチしました ---\n";
69    echo "メッセージ: " . $e->getMessage() . "\n";
70}
71
72echo "\n";
73
74// 2. 正常に処理されるケース
75try {
76    echo processValue("Hello, PHP 8!") . "\n"; // 正しい文字列を渡す
77} catch (MyCustomException $e) {
78    // このブロックは実行されないはずです
79    echo "エラーが発生しましたが、ここでは到達しないはずです。\n";
80}
81
82?>

PHPのExceptionクラスは、プログラムで発生した予期せぬ問題（例外）を扱うための基本的なクラスです。そのコンストラクタである__constructメソッドは、新しい例外オブジェクトを作成する際に、例外に関する重要な情報を初期設定するために用いられます。引数$messageにはエラーの具体的な説明、$codeにはエラーの種類を示す数値、そして$previousにはこの例外の前に発生した別の例外を指定し、例外の連鎖を表現できます。このメソッドはオブジェクトの初期化を行うため、特定の戻り値はありません。

サンプルコードでは、PHP 8で導入された「コンストラクタプロパティプロモーション」という機能を活用し、Exceptionを継承したカスタム例外MyCustomExceptionを定義しています。これにより、コンストラクタの引数public readonly string $customDataが、そのままクラスのプロパティとして自動的に宣言されます。これにより、標準のエラー情報に加え、customDataとして独自の追加情報を例外オブジェクトに持たせることが、より簡潔に記述可能になります。このカスタム例外を使用することで、エラー発生時の状況を詳細に伝え、より効果的なエラーハンドリングを実現できます。