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

Copy
1<?php
2
3/**
4 * ArithmeticError クラスのコンストラクタの例.
5 */
6class MyArithmeticOperation
7{
8    /**
9     * 0で除算する可能性のある処理.
10     *
11     * @param int $numerator   分子
12     * @param int $denominator 分母
13     *
14     * @return float
15     *
16     * @throws ArithmeticError
17     */
18    public function divide(int $numerator, int $denominator): float
19    {
20        if ($denominator === 0) {
21            throw new ArithmeticError("Division by zero is not allowed.", 100);
22        }
23
24        return $numerator / $denominator;
25    }
26}
27
28// ArithmeticErrorをキャッチする例
29try {
30    $operation = new MyArithmeticOperation();
31    $result = $operation->divide(10, 0);
32    echo "Result: " . $result . PHP_EOL; // ここは実行されない
33} catch (ArithmeticError $e) {
34    echo "ArithmeticError caught: " . $e->getMessage() . PHP_EOL;
35    echo "Code: " . $e->getCode() . PHP_EOL;
36}

このサンプルコードは、PHP 8におけるArithmeticErrorクラスのコンストラクタ__constructの使用例を示しています。ArithmeticErrorは、算術演算中に発生するエラーを表す例外クラスです。

サンプルでは、MyArithmeticOperationというクラスで、0で除算する可能性のあるdivideメソッドを定義しています。divideメソッド内で、分母が0の場合にArithmeticErrorをスローしています。ArithmeticErrorのコンストラクタ__constructは、以下の引数を受け取ります。

• $message: エラーメッセージを文字列で指定します（省略可能）。
• $code: エラーコードを整数で指定します（省略可能）。
• $previous: この例外を発生させた以前の例外オブジェクトを指定します（省略可能）。

サンプルコードでは、エラーメッセージとして"Division by zero is not allowed."、エラーコードとして100を__constructに渡しています。

try-catchブロックを使用して、ArithmeticErrorをキャッチしています。catchブロック内では、$e->getMessage()でエラーメッセージを取得し、$e->getCode()でエラーコードを取得して出力しています。

この例から、ArithmeticErrorが発生する可能性のある処理をtry-catchブロックで囲み、エラー発生時に適切な処理を行うことで、プログラムの安定性を向上させることができることがわかります。ArithmeticErrorを適切に利用することで、0除算などの算術エラーを検出し、ユーザーに分かりやすいエラーメッセージを表示したり、ログに記録したりすることが可能です。

Copy
1<?php
2
3/**
4 * ArithmeticError クラスのコンストラクタの例。
5 * Property Promotion を使用して簡潔に記述する。
6 */
7class MyArithmeticOperation
8{
9    public function __construct(
10        private string $message = '',
11        private int $code = 0,
12        private ?Throwable $previous = null
13    ) {
14        // エラーログ出力など、追加の初期化処理を記述できる
15    }
16
17    public function getMessage(): string
18    {
19        return $this->message;
20    }
21
22    public function getCode(): int
23    {
24        return $this->code;
25    }
26
27    public function getPrevious(): ?Throwable
28    {
29        return $this->previous;
30    }
31}
32
33// ArithmeticErrorを直接インスタンス化するのではなく、
34// 独自の例外クラス内で使用することを想定しています。
35try {
36    // 何らかの算術演算でエラーが発生した場合を想定
37    throw new ArithmeticError("算術エラーが発生しました。", 123);
38} catch (ArithmeticError $e) {
39    // ArithmeticErrorをキャッチして処理
40    $myError = new MyArithmeticOperation(
41        $e->getMessage(),
42        $e->getCode(),
43        $e->getPrevious()
44    );
45
46    echo "エラーメッセージ: " . $myError->getMessage() . PHP_EOL;
47    echo "エラーコード: " . $myError->getCode() . PHP_EOL;
48    // 必要に応じて以前の例外も処理する
49}

このサンプルコードは、PHP 8でArithmeticErrorクラスのコンストラクタ (__construct) をどのように使用するかを示しています。特に、Property PromotionというPHP 8の新機能を利用して、コンストラクタの引数でプロパティの定義と初期化を同時に行うことで、コードを簡潔に記述しています。

ArithmeticErrorは、算術演算におけるエラーを表す例外クラスです。コンストラクタは、エラーメッセージ ($message：文字列)、エラーコード ($code：整数)、そして以前に発生した例外 ($previous：Throwableオブジェクトまたはnull) を引数として受け取ります。これらの引数は、エラーに関する詳細情報を提供するために使用されます。

サンプルコードでは、MyArithmeticOperationクラスを作成し、そのコンストラクタ内でProperty Promotionを使用しています。private string $message = ''のように、引数の前にprivateキーワードを付与することで、クラスのプロパティとして自動的に定義され、引数の値で初期化されます。こうすることで、コンストラクタ内でプロパティを個別に定義して代入する手間を省けます。

ArithmeticErrorを直接インスタンス化するのではなく、独自の例外クラス内で使用することを想定しています。try-catchブロック内でArithmeticErrorが発生した場合、それをキャッチして、MyArithmeticOperationクラスのインスタンスを作成し、エラーメッセージやエラーコードを取得して処理しています。getMessage()、getCode()、getPrevious()メソッドは、それぞれエラーメッセージ、エラーコード、そして以前の例外を取得するために使用されます。