【PHP8.x】Exception::__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として独自の追加情報を例外オブジェクトに持たせることが、より簡潔に記述可能になります。このカスタム例外を使用することで、エラー発生時の状況を詳細に伝え、より効果的なエラーハンドリングを実現できます。

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 * カスタム例外クラスの定義
5 *
6 * PHPの標準Exceptionクラスを継承することで、独自の例外を作成します。
7 * この例では、コンストラクタ内で親クラス(Exception)のコンストラクタを呼び出すことで、
8 * 基本的な例外のプロパティ（メッセージ、コード、前の例外）を初期化する方法を示します。
9 */
10class MyCustomException extends Exception
11{
12    /**
13     * MyCustomExceptionクラスのコンストラクタ
14     *
15     * 親クラスであるExceptionの__constructメソッドを呼び出し、
16     * エラーメッセージ、エラーコード、前の例外（例外チェイニング用）を設定します。
17     * このメソッドの引数は、PHP 8のException::__constructのシグネチャと一致させています。
18     *
19     * @param string         $message  エラーメッセージ (デフォルトは空文字列)
20     * @param int            $code     エラーコード (デフォルトは0)
21     * @param Throwable|null $previous 前の例外オブジェクト。例外チェイニングに利用します。
22     *                                 null許容型として定義されており、PHP 7以降で利用可能な型ヒントです。
23     */
24    public function __construct(string $message = "", int $code = 0, ?Throwable $previous = null)
25    {
26        // ここで親クラス (Exception) のコンストラクタを呼び出します。
27        // これにより、PHPの組み込み例外処理メカニズムが適切に機能するために必要な
28        // メッセージ、コード、前の例外の情報が、Exceptionオブジェクトに設定されます。
29        parent::__construct($message, $code, $previous);
30
31        // 必要であれば、MyCustomException固有の初期化ロジックをここに追加できます。
32        // 例: ログ記録、特定の追加プロパティの初期化など。
33    }
34}
35
36/**
37 * カスタム例外の使用例を示す関数
38 *
39 * @param bool $shouldThrow 例外をスローするかどうかを制御するフラグ
40 */
41function demonstrateCustomExceptionUsage(bool $shouldThrow): void
42{
43    echo "--- 例外処理デモンストレーション --- \n";
44    try {
45        if ($shouldThrow) {
46            echo "カスタム例外をスローします...\n";
47            // MyCustomExceptionのインスタンスを作成し、スローします。
48            // この際、上で定義した__constructメソッドが呼び出され、
49            // その中でparent::__constructも実行されます。
50            throw new MyCustomException("処理が失敗しました。", 500, new RuntimeException("内部的な問題"));
51        } else {
52            echo "例外はスローされませんでした。\n";
53        }
54    } catch (MyCustomException $e) {
55        // MyCustomExceptionが捕捉された場合の処理
56        echo "MyCustomExceptionを捕捉しました:\n";
57        echo "  メッセージ: " . $e->getMessage() . "\n";
58        echo "  コード: " . $e->getCode() . "\n";
59        echo "  発生ファイル: " . $e->getFile() . "\n";
60        echo "  発生行: " . $e->getLine() . "\n";
61
62        // 例外チェイニングにより前の例外が存在する場合
63        if ($e->getPrevious() !== null) {
64            echo "  前の例外: " . $e->getPrevious()->getMessage() . "\n";
65        }
66    } catch (Exception $e) {
67        // その他の一般的なExceptionが捕捉された場合の処理
68        echo "一般的なExceptionを捕捉しました: " . $e->getMessage() . "\n";
69    } finally {
70        echo "例外処理ブロックを終了しました。\n\n";
71    }
72}
73
74// 例1: カスタム例外をスローするケース
75demonstrateCustomExceptionUsage(true);
76
77// 例2: 例外をスローしないケース
78demonstrateCustomExceptionUsage(false);
79
80?>

PHPのException::__constructは、プログラム実行中に予期せぬ問題（例外）が発生した際に、その情報をカプセル化するExceptionオブジェクトが作られる時に自動的に実行される、特別な初期化メソッドです。このメソッドは、例外に関する基本的な情報を設定するために使用されます。

引数には、$message、$code、$previousの3つがあります。$messageには、エラーの具体的な内容を文字列で指定します。$codeは、エラーの種類を数値で識別するためのコードです。そして$previousには、現在の例外が別の例外によって引き起こされた場合に、その元の例外オブジェクトを渡します。これを「例外チェイニング」と呼び、問題の根本原因を追跡するのに非常に役立ちます。このメソッドはオブジェクトの初期化を行うコンストラクタであるため、戻り値はありません。

サンプルコードのMyCustomExceptionのように、PHPの標準Exceptionクラスを継承して独自の例外クラスを作る際には、parent::__construct($message, $code, $previous);と記述して、親クラス（Exception）のコンストラクタを呼び出すことが非常に重要です。これにより、メッセージやコード、前の例外といったExceptionオブジェクトの基本的なプロパティが適切に初期化され、作成したカスタム例外がPHPの標準的な例外処理システムと連携して正しく機能するようになります。

Copy
1<?php
2
3/**
4 * ユーザーが提供するデータを処理する関数です。
5 * データが空の場合、Exception をスローします。
6 *
7 * @param string $userData 処理対象のデータ文字列。
8 * @return string 処理されたデータ。
9 * @throws Exception 入力データが空の場合にスローされます。
10 */
11function processUserData(string $userData): string
12{
13    // 入力データが空かどうかをチェックします。
14    if (empty($userData)) {
15        // ここで Exception クラスのコンストラクタ (__construct) を使用して、
16        // 新しい例外オブジェクトを生成し、スローしています。
17        // 引数: string $message (例外のメッセージ), int $code (例外のコード)
18        throw new Exception("入力されたデータが空です。", 1001);
19    }
20
21    // データが有効な場合、処理を続行します。
22    return "データが正常に処理されました: " . strtoupper($userData);
23}
24
25// --- サンプルコードの実行例 ---
26
27echo "--- 1. 正常なデータが渡された場合の処理 ---" . PHP_EOL;
28try {
29    $validResult = processUserData("php example data");
30    echo $validResult . PHP_EOL; // 処理されたデータが表示されます。
31} catch (Exception $e) {
32    // このケースでは例外は発生しないため、このブロックは実行されません。
33    echo "予期せぬ例外が発生しました: " . $e->getMessage() . PHP_EOL;
34}
35
36echo PHP_EOL . "--- 2. 空のデータが渡され、例外が発生する場合の処理 ---" . PHP_EOL;
37try {
38    $invalidResult = processUserData(""); // ここで例外がスローされます。
39    echo $invalidResult . PHP_EOL; // この行は実行されません。
40} catch (Exception $e) {
41    // スローされた Exception がここで捕捉されます。
42    echo "例外を捕捉しました！" . PHP_EOL;
43    echo "エラーメッセージ: " . $e->getMessage() . PHP_EOL; // Exception コンストラクタで設定したメッセージ
44    echo "エラーコード: " . $e->getCode() . PHP_EOL;     // Exception コンストラクタで設定したコード
45    echo "例外発生ファイル: " . $e->getFile() . PHP_EOL;
46    echo "例外発生行: " . $e->getLine() . PHP_EOL;
47    // $e->getPrevious() は、より前の例外がネストされている場合に有用ですが、
48    // このシンプルな例では `null` になります。
49}
50
51echo PHP_EOL . "--- 例外を適切に処理したため、スクリプトは続行されます。 ---" . PHP_EOL;
52
53?>

このPHPサンプルコードは、プログラム実行中に予期せぬ問題が発生した場合に、その状況を伝えるために用いられるExceptionクラスと、そのインスタンス（オブジェクト）を生成する際に使用する特別なメソッドである__constructについて説明しています。

__constructメソッドは、new Exception(...)のように新しい例外オブジェクトを初期化する際に自動的に呼び出されます。この例ではprocessUserData関数内で、入力データが空の場合にthrow new Exception("入力されたデータが空です。", 1001);という形で呼び出されています。ここで引数として、エラーの具体的な内容を示すメッセージ文字列（$message）と、エラーの種類を識別するための数値コード（$code）を渡しています。これにより、生成される例外オブジェクトに「入力されたデータが空です。」というメッセージと「1001」というコードが設定されます。__construct自体は、例外オブジェクトを生成・初期化する役割を終えると処理を終了し、直接の戻り値はありません。

スクリプトの実行例では、try-catchブロックを使用して例外を捕捉し、適切に処理する方法を示しています。catchブロック内で例外が捕捉されると、getMessage()やgetCode()メソッドを使って、__constructで設定されたメッセージやコードを取り出し、エラーの詳細をユーザーに提示しています。これにより、エラーが発生してもプログラムが突然終了することなく、適切なエラーハンドリングを行うことができます。