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

Copy
1<?php
2
3/**
4 * カスタム例外クラスの例。
5 * Error クラスを拡張し、property promotion を使用してコンストラクタ引数をプロパティに割り当てます。
6 */
7class CustomException extends Error
8{
9    /**
10     * CustomException constructor.
11     *
12     * @param string $message 例外メッセージ (デフォルト: '')
13     * @param int $code 例外コード (デフォルト: 0)
14     * @param ?Throwable $previous 前の例外 (デフォルト: null)
15     */
16    public function __construct(
17        public string $message = '',
18        public int $code = 0,
19        public ?Throwable $previous = null
20    ) {
21        // 親クラスのコンストラクタを呼び出す
22        parent::__construct($message, $code, $previous);
23    }
24
25    /**
26     * 例外情報を文字列として返す例 (オーバーライド)。
27     *
28     * @return string 例外情報
29     */
30    public function __toString(): string
31    {
32        return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
33    }
34}
35
36// 例外を発生させてみる
37try {
38    throw new CustomException("カスタム例外が発生しました。", 123);
39} catch (CustomException $e) {
40    echo $e; // 例外情報を出力
41    echo "例外コード: " . $e->getCode() . PHP_EOL; // 例外コードを出力
42    echo "例外メッセージ: " . $e->getMessage() . PHP_EOL; // 例外メッセージを出力
43}

このサンプルコードは、PHPのErrorクラスを拡張したカスタム例外クラスCustomExceptionの例を示しています。Errorクラスは、PHP 8で導入されたエラー処理のための基底クラスです。

__constructメソッドは、Errorクラスのコンストラクタであり、新しい例外オブジェクトを生成する際に呼び出されます。この例では、PHP 8のProperty Promotionという機能を利用して、コンストラクタの引数を直接プロパティとして定義しています。これにより、$message（例外メッセージ）、$code（例外コード）、$previous（前の例外）の3つの引数を、クラスのプロパティに簡潔に割り当てています。

$messageは文字列で、例外の内容を表します。デフォルト値は空文字列です。$codeは整数で、例外を識別するためのコードです。デフォルト値は0です。$previousはThrowableインターフェースを実装したオブジェクトで、前の例外への参照を保持します。デフォルト値はnullです。

parent::__construct($message, $code, $previous);の行では、親クラスであるErrorクラスのコンストラクタを呼び出し、例外の基本的な情報を設定しています。

__toStringメソッドは、例外オブジェクトを文字列として表現するためにオーバーライドされています。このメソッドは、例外が発生した際にechoなどでオブジェクトを出力する際に自動的に呼ばれます。

サンプルコードでは、try-catchブロックを使ってCustomExceptionを発生させ、キャッチしています。キャッチした例外オブジェクトから、getCode()メソッドで例外コードを、getMessage()メソッドで例外メッセージを取得し、出力しています。

Copy
1<?php
2
3/**
4 * カスタムエラーハンドリングの例.
5 */
6class CustomError extends Error
7{
8    /**
9     * CustomError constructor.
10     *
11     * @param string $message  エラーメッセージ
12     * @param int $code       エラーコード
13     * @param ?Throwable $previous  前の例外
14     */
15    public function __construct(string $message = '', int $code = 0, ?Throwable $previous = null)
16    {
17        // 親クラスのコンストラクタを呼び出す
18        parent::__construct($message, $code, $previous);
19    }
20
21    /**
22     * エラー情報を表示する.
23     */
24    public function displayError(): void
25    {
26        echo "Custom Error: " . $this->getMessage() . " (Code: " . $this->getCode() . ")" . PHP_EOL;
27        if ($this->getPrevious()) {
28            echo "Previous Exception: " . $this->getPrevious()->getMessage() . PHP_EOL;
29        }
30    }
31}
32
33// CustomErrorのインスタンスを作成し、エラーを表示する
34try {
35    throw new CustomError("Something went wrong!", 500);
36} catch (CustomError $e) {
37    $e->displayError();
38}
39
40// 以前の例外を持つCustomErrorのインスタンスを作成し、エラーを表示する
41try {
42    try {
43        throw new Exception("Inner exception");
44    } catch (Exception $e) {
45        throw new CustomError("Outer exception", 400, $e);
46    }
47} catch (CustomError $e) {
48    $e->displayError();
49}

PHP 8におけるErrorクラスのコンストラクタ__constructメソッドの利用例です。このメソッドは、Errorオブジェクトを初期化するために使用されます。Errorクラスを継承したカスタムエラーを作成する際に、親クラスのコンストラクタを呼び出すことが重要です。

サンプルコードでは、CustomErrorクラスを定義し、Errorクラスを継承しています。__constructメソッド内でparent::__construct($message, $code, $previous)を呼び出すことで、親クラスの初期化処理を確実に実行しています。

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

• $message: エラーメッセージを表す文字列です。省略可能で、デフォルトは空文字列です。
• $code: エラーコードを表す整数です。省略可能で、デフォルトは0です。
• $previous: 前の例外オブジェクトを表すThrowable型です。省略可能で、デフォルトはnullです。例外が連鎖している場合に、前の例外情報を保持するために使用されます。

サンプルコードでは、displayErrorメソッドを定義し、エラーメッセージ、エラーコード、および前の例外のメッセージを表示しています。try-catchブロックを使用することで、CustomErrorを捕捉し、エラー情報を表示できます。getPreviousメソッドを使用することで、前の例外オブジェクトを取得できます。

この例では、エラー発生時に詳細な情報を取得し、エラーハンドリングをより柔軟に行う方法を示しています。Errorクラスを継承し、__constructメソッドを適切に利用することで、より堅牢なエラー処理を実装できます。

Copy
1<?php
2
3// Errorクラスのコンストラクタの動作をサンプルコードで示します。
4// Errorクラスは、PHP内部の実行時エラーの基底クラスです。
5// 通常、アプリケーションレベルのエラーにはExceptionクラスまたはそのサブクラスを使用しますが、
6// ここではErrorクラス自体のコンストラクタの使用方法を直接示します。
7
8/**
9 * カスタムエラーをスローし、そのエラーをキャッチする関数
10 *
11 * @param string $message エラーメッセージ
12 * @param int $code エラーコード
13 * @param Throwable|null $previous チェーンされた前の例外またはエラー
14 */
15function triggerAndCatchCustomError(string $message, int $code = 0, ?Throwable $previous = null): void
16{
17    echo "--- エラー発生を試行中 ---" . PHP_EOL;
18    try {
19        // Errorクラスのコンストラクタを呼び出して、新しいErrorオブジェクトを作成しスローします。
20        // 引数: string $message, int $code, ?Throwable $previous
21        throw new Error($message, $code, $previous);
22    } catch (Error $e) {
23        // スローされたErrorオブジェクトをキャッチします。
24        // ここでErrorクラスのインスタンスが持っている情報にアクセスできます。
25        echo "エラーをキャッチしました！" . PHP_EOL;
26        echo "メッセージ: " . $e->getMessage() . PHP_EOL;
27        echo "コード: " . $e->getCode() . PHP_EOL;
28        echo "ファイル: " . $e->getFile() . PHP_EOL;
29        echo "行: " . $e->getLine() . PHP_EOL;
30
31        // $previous引数で指定された前のエラーや例外が存在する場合、それも表示します。
32        if ($e->getPrevious() !== null) {
33            echo "前のエラー/例外のメッセージ: " . $e->getPrevious()->getMessage() . PHP_EOL;
34            echo "前のエラー/例外のコード: " . $e->getPrevious()->getCode() . PHP_EOL;
35        }
36    }
37    echo "--- 処理を続行 ---" . PHP_EOL . PHP_EOL;
38}
39
40// 1. 基本的なエラーメッセージとコードでErrorクラスのコンストラクタを使用する例
41triggerAndCatchCustomError("何らかのシステムエラーが発生しました。", 500);
42
43// 2. 前の例外をチェーンしてErrorクラスのコンストラクタを使用する例
44try {
45    // まず、何らかの基になる例外を発生させます
46    throw new InvalidArgumentException("無効な入力値です", 101);
47} catch (InvalidArgumentException $originalException) {
48    // その例外を$previous引数としてErrorコンストラクタに渡します
49    triggerAndCatchCustomError(
50        "処理中に予期せぬエラーが発生しました。",
51        503,
52        $originalException
53    );
54}
55
56// 3. 引数を省略したErrorクラスのコンストラクタを使用する例 (デフォルト値が適用されます)
57triggerAndCatchCustomError(""); // メッセージが空、コードが0

PHP 8におけるErrorクラスの__constructメソッドは、実行時エラーを表す新しいErrorオブジェクトを初期化する際に使用されます。このコンストラクタは、new Error(...)という形式で呼び出され、以下の引数を受け取ります。最初の引数$messageにはエラーの内容を説明する文字列、次の$codeにはエラーを識別するための整数値を指定します。最後の引数$previousには、このErrorが発生する前に発生した別のThrowable（例外やエラー）を指定でき、これによりエラーの発生履歴を追跡する「エラーの連鎖」を構築できます。

ErrorクラスはPHP内部の実行時エラーの基底クラスですが、そのコンストラクタの動作はExceptionクラスと似ており、通常はthrow new Error(...)のようにthrow文と組み合わせてエラーを発生させます。このメソッドを使うことで、発生したエラーにメッセージやコード、さらに元となったエラー情報を付与し、プログラムで捕捉して適切に処理できるようになります。コンストラクタはオブジェクトを生成し初期化する役割のため、戻り値はありません。

Copy
1<?php
2
3/**
4 * 特定の条件に応じてPHPの組み込みErrorクラスをスローする関数。
5 *
6 * Error::__construct メソッドは、エラーメッセージ、エラーコード、
7 * そしてオプションとして以前のスロー可能オブジェクト（例外など）を受け取ります。
8 * これは内部的なエラーや、通常の例外では表現しにくい状況を扱う際に利用されます。
9 *
10 * @param string|null $data 処理対象のデータ。nullの場合はErrorをスローします。
11 * @throws Error データが特定の条件を満たさない場合にスローされます。
12 */
13function processData(?string $data): void
14{
15    // === 1. Error::__construct の基本的な使用例: メッセージとコードのみ ===
16    if ($data === null) {
17        // Errorクラスの新しいインスタンスを作成し、スローします。
18        // __construct メソッドは、引数としてエラーメッセージとエラーコードを受け取ります。
19        throw new Error("データはnullであってはなりません。", 1001);
20    }
21
22    // === 2. Error::__construct の発展的な使用例: 以前のスロー可能オブジェクトを渡す ===
23    // 何らかの処理中に別のエラー（例外など）が発生し、それをより高レベルのErrorとしてラップする場合
24    if (empty($data)) {
25        try {
26            // 例として、不適切な引数に対する組み込み例外を発生させてみます。
27            throw new InvalidArgumentException("入力データは空であってはなりません。");
28        } catch (InvalidArgumentException $e) {
29            // 発生した例外 ($e) を第三引数 $previous として新しいErrorに渡します。
30            // これにより、エラーの原因を追跡しやすくなります。
31            throw new Error("データの処理に失敗しました。詳細については以前のエラーを参照してください。", 1002, $e);
32        }
33    }
34
35    echo "データ処理成功: " . $data . PHP_EOL;
36}
37
38// --- サンプルコードの実行部分 ---
39
40echo "--- 正常なデータ ---" . PHP_EOL;
41try {
42    processData("有効なデータ");
43} catch (Error $e) {
44    echo "予期せぬエラーを捕捉しました: " . $e->getMessage() . PHP_EOL;
45}
46echo PHP_EOL;
47
48echo "--- nullデータの場合 (基本Error) ---" . PHP_EOL;
49try {
50    processData(null); // ここで Error がスローされます。
51} catch (Error $e) {
52    // スローされた Error オブジェクトを捕捉します。
53    echo "捕捉されたエラー:" . PHP_EOL;
54    echo "  メッセージ: " . $e->getMessage() . PHP_EOL;
55    echo "  コード: " . $e->getCode() . PHP_EOL;
56    echo "  発生ファイル: " . $e->getFile() . PHP_EOL;
57    echo "  発生行: " . $e->getLine() . PHP_EOL;
58    // Error には前の例外はありません。
59    if ($e->getPrevious() !== null) {
60        echo "  以前の例外メッセージ: " . $e->getPrevious()->getMessage() . PHP_EOL;
61    }
62}
63echo PHP_EOL;
64
65echo "--- 空のデータの場合 (Previous例外付きError) ---" . PHP_EOL;
66try {
67    processData(""); // ここで Error (previous付き) がスローされます。
68} catch (Error $e) {
69    // スローされた Error オブジェクトを捕捉します。
70    echo "捕捉されたエラー:" . PHP_EOL;
71    echo "  メッセージ: " . $e->getMessage() . PHP_EOL;
72    echo "  コード: " . $e->getCode() . PHP_EOL;
73    echo "  発生ファイル: " . $e->getFile() . PHP_EOL;
74    echo "  発生行: " . $e->getLine() . PHP_EOL;
75    // previous（以前の例外）が存在するか確認し、その情報を表示します。
76    if ($e->getPrevious() !== null) {
77        echo "  以前の例外クラス: " . get_class($e->getPrevious()) . PHP_EOL;
78        echo "  以前の例外メッセージ: " . $e->getPrevious()->getMessage() . PHP_EOL;
79        echo "  以前の例外コード: " . $e->getPrevious()->getCode() . PHP_EOL;
80    }
81}
82echo PHP_EOL;
83
84?>

PHPのErrorクラスの__constructメソッドは、PHPの内部的なエラーを表すErrorオブジェクトを初期化するために使用されます。このメソッドは、Errorをthrow new Error(...)のように新しく生成する際に自動的に呼び出されます。

第一引数$messageには、発生したエラーの具体的な内容を説明する文字列を指定します。このメッセージは、エラーが捕捉された際にユーザーや開発者に状況を伝えるために利用されます。第二引数$codeには、エラーを識別するための任意の整数コードを設定できます。これは、複数のエラータイプを区別したり、特定の処理フローに応じたエラーハンドリングを行う際に役立ちます。

さらに第三引数$previousには、このエラーが発生する原因となった別のスロー可能オブジェクト（例えば、捕獲した例外や他のエラーオブジェクト）を渡すことができます。この機能により、エラーの発生源をたどる「エラーチェーン」を構築でき、複雑なシステムにおける問題の根本原因を詳細に追跡することが可能になります。

例えば、特定のデータがnullであった場合にエラーを発生させたり、別の下位レベルの例外を捕捉し、それを原因とするより上位のエラーとしてラップしたりする際にこのメソッドが利用されます。このメソッド自体は、Errorオブジェクトの初期化を行うコンストラクタであるため、明示的な戻り値はありません。