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

Copy
1<?php
2
3/**
4 * ゼロ除算の可能性を示すサンプル関数。
5 *
6 * この関数は、除数がゼロの場合にDivisionByZeroErrorをスローします。
7 * これは、エラーオブジェクトのコンストラクタ (__construct) にメッセージを渡して
8 * 初期化する方法を示す例です。
9 *
10 * @param int $numerator 被除数
11 * @param int $denominator 除数
12 * @return float 商
13 * @throws DivisionByZeroError 除数がゼロの場合
14 */
15function performDivision(int $numerator, int $denominator): float
16{
17    if ($denominator === 0) {
18        // DivisionByZeroError クラスのコンストラクタ (__construct) を使用して、
19        // カスタムのエラーメッセージを初期化しています。
20        // __construct の引数: string $message = "", int $code = 0, ?Throwable $previous = null
21        throw new DivisionByZeroError("除数はゼロにできません。計算: {$numerator} / {$denominator}");
22    }
23    return $numerator / $denominator;
24}
25
26echo "--- カスタムメッセージで DivisionByZeroError をスローする例 ---\n";
27try {
28    // performDivision 関数で意図的にゼロ除算を発生させ、
29    // __construct で設定したカスタムメッセージを持つエラーを捕捉します。
30    echo performDivision(10, 0) . "\n";
31} catch (DivisionByZeroError $e) {
32    echo "捕捉されたエラーメッセージ: " . $e->getMessage() . "\n";
33    echo "エラーコード: " . $e->getCode() . "\n";
34}
35
36echo "\n--- PHP 内部で生成される DivisionByZeroError の例 ---\n";
37try {
38    // PHP 8 以降では、0 で除算を行うと自動的に DivisionByZeroError がスローされます。
39    // この場合、PHP がデフォルトのメッセージで DivisionByZeroError の __construct を呼び出します。
40    $result = 10 / 0; // ここで DivisionByZeroError が発生
41    echo $result . "\n";
42} catch (DivisionByZeroError $e) {
43    echo "捕捉されたエラーメッセージ: " . $e->getMessage() . "\n";
44    echo "エラーコード: " . $e->getCode() . "\n";
45}
46
47echo "\n--- 正常な除算の例 ---\n";
48try {
49    echo "10 / 2 = " . performDivision(10, 2) . "\n";
50} catch (DivisionByZeroError $e) {
51    // このブロックは正常な除算では実行されません。
52    echo "予期せぬエラー: " . $e->getMessage() . "\n";
53}
54

PHPのDivisionByZeroErrorクラスは、プログラムが数値をゼロで割ろうとした際に発生するエラーを示すものです。このクラスの__constructメソッドは、DivisionByZeroErrorオブジェクトを新しく作成し、その初期設定を行うための特別なメソッドです。

このメソッドは、エラーの詳細を伝えるための文字列$message、エラーを識別するための整数値$code、そしてこのエラーが発生する前に発生した別のエラーを示す$previousを引数として受け取ります。$messageや$codeは省略可能で、省略された場合はデフォルト値が設定されます。__constructメソッドは新しいオブジェクトを初期化する役割のため、明示的な戻り値はありません。

サンプルコードでは、performDivision関数内で除数がゼロの場合に、new DivisionByZeroError("除数はゼロにできません...")として__constructを呼び出し、$message引数にカスタムエラーメッセージを渡してオブジェクトを初期化しています。これにより、try-catchブロックでエラーを捕捉した際に、設定したカスタムメッセージを取得できます。また、PHP 8以降では直接10 / 0のようなゼロ除算を行うと、PHPが自動的にDivisionByZeroErrorを生成し、デフォルトのメッセージで__constructが呼び出されます。これは、プログラムが予期せぬゼロ除算によって停止するのを防ぐために利用されます。

Copy
1<?php
2
3/**
4 * PHP 8 のコンストラクタ・プロパティ・プロモーションを使用して、
5 * 計算に必要な設定を保持するクラスを定義します。
6 * 引数にアクセス修飾子 (public/private/protected) を付与することで、
7 * その引数は自動的に同名のプロパティとして初期化されます。
8 */
9class CalculatorSettings
10{
11    /**
12     * 新しい CalculatorSettings インスタンスを作成します。
13     *
14     * @param float $numerator   除算で使用する分子
15     * @param float $denominator 除算で使用する分母
16     */
17    public function __construct(
18        // public を付けることで、自動的に public $numerator プロパティが作成され、引数の値で初期化されます。
19        public float $numerator,
20        // public を付けることで、自動的に public $denominator プロパティが作成され、引数の値で初期化されます。
21        public float $denominator
22    ) {
23        // コンストラクタ本体。プロパティプロモーションにより、
24        // 上記の引数は自動的に同名のプロパティとして初期化されるため、
25        // ここに $this->numerator = $numerator; のような記述は不要です。
26    }
27}
28
29/**
30 * 設定オブジェクトに基づいて除算を実行し、DivisionByZeroError を捕捉する関数。
31 * DivisionByZeroError は、PHP 8 で0除算が発生したときに自動的にスローされるエラーです。
32 *
33 * @param CalculatorSettings $settings 計算設定を含むオブジェクト
34 * @return float|null 除算結果、またはエラーが発生した場合は null
35 */
36function performDivision(CalculatorSettings $settings): ?float
37{
38    echo "--- 除算処理を開始します ---" . PHP_EOL;
39    echo "分子 (Numerator): " . $settings->numerator . PHP_EOL;
40    echo "分母 (Denominator): " . $settings->denominator . PHP_EOL;
41
42    try {
43        // ゼロ除算を試みる
44        // PHP 8 では、0で割ると自動的に DivisionByZeroError がスローされます。
45        $result = $settings->numerator / $settings->denominator;
46        echo "結果: " . $result . PHP_EOL;
47        return $result;
48    } catch (DivisionByZeroError $e) {
49        // DivisionByZeroError を捕捉し、エラーメッセージを表示します。
50        // リファレンス情報にあるように、エラーオブジェクトにはメッセージ、コードなどが含まれます。
51        echo "エラーを捕捉しました: " . $e->getMessage() . PHP_EOL;
52        echo "エラーコード: " . $e->getCode() . PHP_EOL;
53        echo "エラーが発生したファイル: " . $e->getFile() . " (行: " . $e->getLine() . ")" . PHP_EOL;
54        return null; // エラー時は null を返して処理を継続
55    } finally {
56        // try-catch ブロックの後に必ず実行される処理
57        echo "--- 除算処理を終了します ---" . PHP_EOL . PHP_EOL;
58    }
59}
60
61// --- サンプルコードの実行 ---
62
63// ケース1: 正常な除算
64// CalculatorSettings のコンストラクタでプロパティプロモーションが使われています。
65$settings1 = new CalculatorSettings(10.0, 2.0);
66performDivision($settings1);
67
68// ケース2: ゼロ除算 (DivisionByZeroError が発生するケース)
69$settings2 = new CalculatorSettings(5.0, 0.0);
70performDivision($settings2);
71
72// ケース3: 別の正常な除算
73$settings3 = new CalculatorSettings(7.0, 3.0);
74performDivision($settings3);

このコードは、PHP 8で導入された「コンストラクタ・プロパティ・プロモーション」と、ゼロ除算時に発生するDivisionByZeroErrorの扱い方を示しています。まずCalculatorSettingsクラスでは、コンストラクタの引数にpublicのようなアクセス修飾子を付けることで、その引数が自動的に同名のプロパティとして初期化されます。これにより、初期化のための記述を簡潔にできます。

performDivision関数では、この設定オブジェクトを使って除算を行います。PHP 8以降では、分母がゼロの場合にDivisionByZeroErrorが自動的にスローされます。このエラーはtry-catchブロックで捕捉することができ、捕捉したエラーオブジェクトからgetMessage()でエラー内容、getCode()でエラーコード、getFile()やgetLine()で発生箇所などの詳細情報を取得できます。

DivisionByZeroErrorクラスの__constructメソッドは、通常、PHPエンジンが内部的にゼロ除算を検知した際に呼び出されます。このコンストラクタは、引数$messageでエラーの説明、$codeでエラーの識別子、$previousで前の例外オブジェクトを受け取り、それらの情報をエラーオブジェクトに設定します。サンプルコードのように直接インスタンスを生成しない場合でも、捕捉したエラーオブジェクトを通じてこれらの情報にアクセスできます。この__constructメソッドは戻り値を持ちません。