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

Copy
1<?php
2
3class CustomException extends ErrorException
4{
5    /**
6     * CustomException constructor.
7     *
8     * @param string $message  The Exception message to throw.
9     * @param int $code The Exception code.
10     * @param int $severity The severity level of the exception.  Defaults to E_ERROR.
11     * @param string $filename The filename where the exception was created.
12     * @param int $lineno The line number where the exception was created.
13     * @param ?Throwable $previous The previous exception used for the exception chaining.
14     */
15    public function __construct(
16        string $message = '',
17        int $code = 0,
18        int $severity = E_ERROR,
19        string $filename = __FILE__,
20        int $lineno = __LINE__,
21        ?Throwable $previous = null
22    ) {
23        // 親クラスのコンストラクタを呼び出す
24        parent::__construct($message, $code, $severity, $filename, $lineno, $previous);
25    }
26
27    public function customMethod(): void
28    {
29        echo "Custom method called from CustomException.\n";
30    }
31}
32
33// 例外を発生させる例
34try {
35    throw new CustomException("This is a custom exception message.", 123, E_WARNING);
36} catch (CustomException $e) {
37    echo "Caught CustomException: " . $e->getMessage() . "\n";
38    echo "Code: " . $e->getCode() . "\n";
39    echo "Severity: " . $e->getSeverity() . "\n";
40    echo "File: " . $e->getFile() . "\n";
41    echo "Line: " . $e->getLine() . "\n";
42    $e->customMethod();
43}

PHP 8におけるErrorExceptionクラスのコンストラクタ__constructメソッドの利用例です。このメソッドは、カスタム例外クラスを作成する際に、例外に関する様々な情報を初期化するために使用されます。

サンプルコードでは、ErrorExceptionを継承したCustomExceptionクラスを定義し、そのコンストラクタ内で親クラス(ErrorException)のコンストラクタを呼び出しています。

__constructメソッドは、以下の引数を受け取ります。

• $message: 例外メッセージ（文字列）。省略時は空文字列です。
• $code: 例外コード（整数）。省略時は0です。
• $severity: 例外の重要度（整数）。E_ERROR, E_WARNING, E_NOTICEなどの定数を使用します。省略時はE_ERRORです。
• $filename: 例外が発生したファイル名（文字列）。省略時は__FILE__（現在のファイル名）です。
• $lineno: 例外が発生した行番号（整数）。省略時は__LINE__（現在の行番号）です。
• $previous: 以前の例外オブジェクト (Throwable)。例外の連鎖を表現する際に使用します。省略時は null です。

コンストラクタ内では、これらの引数を親クラスのコンストラクタに渡すことで、例外オブジェクトの初期化を行います。

サンプルコードでは、try-catchブロックを使ってCustomExceptionを発生させ、キャッチしています。キャッチした例外オブジェクトから、getMessage(), getCode(), getSeverity(), getFile(), getLine()メソッドを使って、それぞれの情報を取得し、表示しています。また、CustomExceptionクラスに定義した独自のメソッドcustomMethod()を呼び出す例も示しています。

このように、ErrorExceptionのコンストラクタを適切に使用することで、詳細な情報を持つカスタム例外を作成し、エラーハンドリングを効果的に行うことができます。

Copy
1<?php
2
3/**
4 * ErrorException のコンストラクタの例
5 */
6try {
7    // 意図的にエラーを発生させる
8    throw new Exception("サンプル例外");
9} catch (Exception $e) {
10    // 例外を ErrorException に変換する
11    $errorException = new ErrorException(
12        $e->getMessage(), // エラーメッセージ
13        $e->getCode(),    // エラーコード
14        E_ERROR,           // エラーレベル (E_ERROR, E_WARNING, E_NOTICE など)
15        __FILE__,          // ファイル名
16        __LINE__,          // 行番号
17        $e                 // 前の例外 (Throwable インスタンス)
18    );
19
20    // ErrorException を処理する
21    echo "ErrorException が発生しました: " . $errorException->getMessage() . "\n";
22    echo "ファイル: " . $errorException->getFile() . "\n";
23    echo "行: " . $errorException->getLine() . "\n";
24}

PHP 8における ErrorException クラスのコンストラクタ __construct の使用例です。ErrorException は、PHP のエラーを例外として扱うためのクラスです。この例では、まず Exception を throw して意図的に例外を発生させ、catch ブロックでそれを捕獲しています。

次に、捕獲した Exception をもとに ErrorException のインスタンスを生成しています。__construct は、エラーメッセージ $message、エラーコード $code、エラーレベル $severity (E_ERROR, E_WARNING など)、ファイル名 $filename、行番号 $lineno、そして前の例外 $previous (Throwable インスタンス) を引数として受け取ります。これらの引数を使って、ErrorException オブジェクトを初期化します。

このサンプルコードでは、Exception オブジェクトからエラーメッセージ、エラーコードを取得し、エラーレベルを E_ERROR に設定、現在のファイル名と行番号、そして元の Exception オブジェクトを $previous として ErrorException に渡しています。

最後に、生成された ErrorException オブジェクトからエラーメッセージ、ファイル名、行番号を取得して表示しています。このように、ErrorException を使用することで、従来のエラー処理を例外処理の枠組みに組み込むことができ、より柔軟なエラーハンドリングが可能になります。$previous 引数を使用することで、例外の連鎖を追跡することも可能です。

Copy
1<?php
2
3/**
4 * PHP 8 の ErrorException を継承したカスタム例外クラスの例です。
5 * カスタム例外を作成する際、親クラスのコンストラクタを呼び出す (`parent::__construct`) 方法を示します。
6 */
7class MyCustomErrorException extends ErrorException
8{
9    /**
10     * MyCustomErrorException クラスの新しいインスタンスを構築します。
11     * 親クラスである ErrorException のコンストラクタと同じ引数を受け取ります。
12     *
13     * @param string $message 例外に関する説明メッセージ。
14     * @param int    $code 例外のコード。
15     * @param int    $severity エラーの深刻度 (例: E_ERROR, E_WARNING, E_USER_NOTICE)。
16     * @param string $filename エラーが発生したファイル名。
17     * @param int    $lineno エラーが発生した行番号。
18     * @param Throwable|null $previous 以前の例外オブジェクト（例外チェイニングに使用）。
19     */
20    public function __construct(
21        string $message = 'カスタムエラーが発生しました。',
22        int $code = 0,
23        int $severity = E_ERROR,
24        string $filename = __FILE__,
25        int $lineno = __LINE__,
26        ?Throwable $previous = null
27    ) {
28        // ここで親クラス（ErrorException）のコンストラクタを呼び出します。
29        // これにより、ErrorException が持つ基本的なプロパティ（メッセージ、コード、深刻度など）が
30        // 適切に初期化され、このカスタム例外が ErrorException として振る舞うことができます。
31        parent::__construct($message, $code, $severity, $filename, $lineno, $previous);
32
33        // 必要に応じて、このカスタム例外固有の追加処理をここで行うことができます。
34        // 例: 特定のログ出力、カスタムプロパティの設定など。
35    }
36
37    /**
38     * カスタムエラーに関する追加情報を提供するメソッドの例。
39     *
40     * @return string 追加情報メッセージ。
41     */
42    public function getAdditionalInfo(): string
43    {
44        return "このエラーはMyCustomErrorExceptionによって処理されました。";
45    }
46}
47
48// --- MyCustomErrorException の使用例 ---
49
50try {
51    // MyCustomErrorException のインスタンスを作成し、スローします。
52    // コンストラクタの引数は parent::__construct() に渡されます。
53    throw new MyCustomErrorException(
54        '設定ファイルが見つかりませんでした。', // $message
55        1001,                                 // $code
56        E_USER_WARNING,                       // $severity (E_ERROR ではなく警告レベルを使用)
57        __FILE__,                             // $filename
58        __LINE__                              // $lineno
59    );
60} catch (MyCustomErrorException $e) {
61    // MyCustomErrorException を捕捉した場合の処理
62    echo "--- MyCustomErrorException を捕捉しました ---\n";
63    echo "メッセージ: " . $e->getMessage() . "\n";
64    echo "コード: " . $e->getCode() . "\n";
65    echo "深刻度: " . $e->getSeverity() . " (E_USER_WARNING の場合 " . E_USER_WARNING . ")\n";
66    echo "発生ファイル: " . $e->getFile() . "\n";
67    echo "発生行: " . $e->getLine() . "\n";
68    echo "追加情報: " . $e->getAdditionalInfo() . "\n";
69    echo "スタックトレース: \n" . $e->getTraceAsString() . "\n";
70} catch (Throwable $e) {
71    // MyCustomErrorException 以外の全ての Throwable (例外やエラー) を捕捉
72    echo "--- その他の例外を捕捉しました ---\n";
73    echo "メッセージ: " . $e->getMessage() . "\n";
74}
75
76echo "\n--- プログラムは続行されます。---\n";
77
78?>

PHP 8のErrorExceptionクラスは、PHPが通常発生させるエラー（警告や致命的なエラーなど）をオブジェクトとして扱えるようにする特別なクラスです。これにより、通常の例外と同様にtry-catchブロックでエラーを捕捉し、柔軟に処理することが可能になります。

このクラスの__constructメソッドは、ErrorExceptionオブジェクトが新しく作成される際に呼び出される特別なメソッドです。引数として、エラーに関する詳細情報を受け取ります。$messageはエラーの具体的な説明、$codeはエラーを識別する番号、$severityはE_ERRORやE_WARNINGといった定数でエラーの深刻度、$filenameはエラー発生ファイル名、$linenoはエラー発生行番号、$previousは例外チェイニングに使用される以前の例外オブジェクトです。これらの引数により、エラーの詳細がオブジェクトに格納されます。このメソッドはオブジェクトを初期化するものであり、明示的な戻り値はありません。

サンプルコードのようにErrorExceptionを継承して独自のカスタム例外クラスを作成する場合、カスタムクラスのコンストラクタ内でparent::__constructを呼び出すことが重要です。これは、親クラスであるErrorExceptionが持つ基本的なエラー情報（メッセージや深刻度など）の初期化処理を適切に行い、カスタム例外がErrorExceptionとしての機能を正しく持てるようにするためです。これにより、ユーザー定義のエラーも標準のエラーと同様に扱えるようになります。

Copy
1<?php
2
3/**
4 * 特定の条件が満たされた場合にErrorExceptionをスローする関数です。
5 * ErrorExceptionクラスの__constructメソッドの使用例を示します。
6 *
7 * @param bool $shouldThrow 例外をスローするかどうかを制御します。trueの場合、例外がスローされます。
8 * @param string $customMessage エラーメッセージとして使用される文字列です。
9 * @param int $customCode エラーコードとして使用される整数値です。
10 * @param int $customSeverity エラーの深刻度を示す整数値です (例: E_USER_ERROR, E_USER_WARNINGなど)。
11 * @param ?Throwable $previous この例外の前の例外 (オプション)。
12 * @throws ErrorException 指定された条件 ($shouldThrow が true) が満たされた場合、ErrorExceptionをスローします。
13 */
14function demonstrateErrorExceptionConstruction(
15    bool $shouldThrow,
16    string $customMessage,
17    int $customCode,
18    int $customSeverity,
19    ?Throwable $previous = null
20): void {
21    if ($shouldThrow) {
22        // ErrorExceptionのコンストラクタを直接呼び出してインスタンスを生成し、スローします。
23        // リファレンスに記載されたすべての引数を明示的に指定しています。
24        throw new ErrorException(
25            $customMessage,      // エラーメッセージ
26            $customCode,         // エラーコード
27            $customSeverity,     // エラーの深刻度 (例: E_ERROR, E_WARNING, E_USER_ERROR など)
28            __FILE__,            // エラーが発生したファイル名 (現在のファイル)
29            __LINE__,            // エラーが発生した行番号 (現在の行)
30            $previous            // 前の例外 (存在する場合)
31        );
32    }
33    echo "例外はスローされませんでした。\n";
34}
35
36// === サンプルコードの実行 ===
37
38echo "--- ErrorExceptionのコンストラクタを試す ---\n";
39
40try {
41    // ケース1: 例外をスローする
42    echo "ケース1: ErrorExceptionをスローします。\n";
43    demonstrateErrorExceptionConstruction(
44        true, // 例外をスローする
45        "データ処理中に致命的なエラーが発生しました！", // カスタムメッセージ
46        500, // カスタムエラーコード
47        E_USER_ERROR // 深刻度: ユーザー定義の致命的なエラー
48    );
49    echo "この行は実行されません。\n"; // 例外がスローされるため
50} catch (ErrorException $e) {
51    echo "ErrorExceptionを捕捉しました。\n";
52    echo "  メッセージ: " . $e->getMessage() . "\n";
53    echo "  コード: " . $e->getCode() . "\n";
54    echo "  深刻度: " . $e->getSeverity() . " (E_USER_ERROR値: " . E_USER_ERROR . ")\n";
55    echo "  ファイル: " . $e->getFile() . "\n";
56    echo "  行: " . $e->getLine() . "\n";
57} catch (Throwable $e) {
58    // ErrorException以外のすべての例外を捕捉
59    echo "予期せぬ例外を捕捉しました: " . $e->getMessage() . "\n";
60}
61
62echo "\n";
63
64try {
65    // ケース2: 例外をスローしない
66    echo "ケース2: ErrorExceptionはスローしません。\n";
67    demonstrateErrorExceptionConstruction(
68        false, // 例外をスローしない
69        "これはダミーメッセージです",
70        0,
71        E_USER_NOTICE
72    );
73} catch (ErrorException $e) {
74    // このケースでは例外はスローされないため、このブロックは実行されません
75    echo "ErrorExceptionを捕捉しました。\n";
76} catch (Throwable $e) {
77    echo "予期せぬ例外を捕捉しました: " . $e->getMessage() . "\n";
78}
79
80echo "\n--- サンプルコードの実行終了 ---\n";
81
82?>

PHP 8のErrorExceptionクラスの__constructメソッドは、PHPの標準的なエラーを、プログラムで捕捉して処理できる「例外」として扱うための特別な初期化メソッドです。このコンストラクタは、ErrorExceptionの新しいインスタンスを生成する際に呼び出され、エラーに関する詳細な情報を設定します。

引数$messageにはエラー内容を示す文字列、$codeにはエラーを識別する整数値を指定します。$severityは、E_ERRORやE_WARNINGといったエラーの深刻度を示す定数を設定し、エラーの種類を明確にします。$filenameと$linenoは、それぞれエラーが発生したファイル名と行番号を自動的に取得し、デバッグの際に重要な情報となります。また、オプションの$previous引数には、この例外の発生前に別の例外が存在した場合にそのインスタンスを指定できます。

__constructはインスタンスを生成するメソッドであり、明示的な戻り値はありません。サンプルコードでは、new ErrorException(...)を使ってこれらの引数を渡すことで、カスタムエラー情報を持つErrorExceptionのインスタンスを作成し、throw文によってその例外を発生させています。これにより、PHPの実行時エラーをより詳細に制御し、堅牢なエラーハンドリングを実装することが可能になります。