【PHP8.x】__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メソッドを適切に利用することで、より堅牢なエラー処理を実装できます。