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

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