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

Copy
1<?php
2
3/**
4 * ゼロによる除算を試み、DivisionByZeroErrorの発生とハンドリングを示す関数です。
5 * DivisionByZeroErrorのgetMessage()メソッドの利用方法を実演し、
6 * キーワード「override getmessage」に関連して、組み込みメッセージを元に
7 * カスタムメッセージを生成する例を示します。
8 *
9 * @param int $numerator 割られる数
10 * @param int $denominator 割る数
11 * @return void
12 */
13function performSafeDivision(int $numerator, int $denominator): void
14{
15    echo "--- {$numerator} を {$denominator} で割る試み ---\n";
16    try {
17        // PHP 8では、ゼロ除算はDivisionByZeroErrorをスローします。
18        // このエラーは直接throwするのではなく、計算式によって発生させます。
19        $result = $numerator / $denominator;
20        echo "結果: {$result}\n";
21    } catch (DivisionByZeroError $e) {
22        // DivisionByZeroErrorをキャッチします。
23        // $e->getMessage() を呼び出すことで、PHPが生成したエラーメッセージを取得します。
24        $defaultErrorMessage = $e->getMessage();
25
26        // 組み込みのgetMessage()から取得したメッセージを利用しつつ、
27        // 初心者にも分かりやすいカスタムメッセージを生成します。
28        // これは直接的な「オーバーライド」ではありませんが、
29        // デフォルトメッセージの代わりにカスタムメッセージを提示する例です。
30        $customErrorMessage = "エラー: ゼロで割ることはできませんでした。\n";
31        $customErrorMessage .= "システムエラー詳細: " . $defaultErrorMessage;
32
33        echo $customErrorMessage . "\n";
34    } catch (Throwable $e) {
35        // DivisionByZeroError以外の予期せぬエラーをキャッチします。
36        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
37    }
38    echo "--- 処理終了 ---\n\n";
39}
40
41// 正常な除算の例
42performSafeDivision(10, 2);
43
44// ゼロによる除算の例
45performSafeDivision(5, 0);
46
47// 別なゼロによる除算の例
48performSafeDivision(100, 0);

DivisionByZeroError::getMessageは、PHP 8でゼロによる除算が試みられた際に発生するDivisionByZeroErrorオブジェクトから、エラーの詳細メッセージを取得するためのメソッドです。このメソッドは引数を一切取らず、エラーの内容を説明する文字列を戻り値として返します。

サンプルコードでは、performSafeDivision関数内で割る数にゼロが指定された場合にDivisionByZeroErrorが発生します。try-catchブロックでこのエラーを捕捉した後、捕捉した$eオブジェクトに対して$e->getMessage()を呼び出すことで、PHPが内部的に生成した「Division by zero」のようなエラーメッセージを取得しています。

取得したデフォルトメッセージ（$defaultErrorMessage）は、システム内部でのエラー内容を正確に伝えます。このメッセージをそのままユーザーに表示するのではなく、より初心者にも分かりやすい「エラー: ゼロで割ることはできませんでした。」といったカスタムメッセージを作成する際に利用する例を示しています。これは、getMessage()メソッド自体を直接「オーバーライド」するものではなく、組み込みのエラーメッセージを参考にしつつ、アプリケーションのニーズに合わせてユーザーフレンドリーなメッセージを生成する、実践的なエラーハンドリングの手法です。getMessage()は、エラー発生時の詳細を把握し、適切な対応を行うための重要なツールとなります。

Copy
1<?php
2
3/**
4 * ゼロによる除算を意図的に発生させる関数。
5 * PHP 8以降では、ゼロによる除算は DivisionByZeroError をスローします。
6 *
7 * @param int $numerator 被除数
8 * @param int $denominator 除数
9 * @return float 除算の結果
10 */
11function performDivision(int $numerator, int $denominator): float
12{
13    // ここで除数がゼロの場合、PHPエンジンが DivisionByZeroError を自動的にスローします。
14    // 例: 10 / 0 のような計算がこれにあたります。
15    return $numerator / $denominator;
16}
17
18// ゼロによる除算を試み、発生したエラーのメッセージを取得する例
19try {
20    echo "ゼロ除算を試みます...\n";
21    // 意図的にゼロ除算を発生させる
22    $result = performDivision(10, 0);
23    echo "結果: " . $result . "\n"; // この行はエラー発生のため実行されません
24} catch (DivisionByZeroError $e) {
25    // DivisionByZeroError を捕捉します。
26    // getMessage() メソッドは、エラーに関する簡潔な説明文字列を返します。
27    // このメッセージはエラーの根本原因を直接示し、通常は短縮（truncated）されません。
28    echo "エラーが発生しました: " . $e->getMessage() . "\n";
29    echo "ファイル: " . $e->getFile() . "\n";
30    echo "行: " . $e->getLine() . "\n";
31} catch (Throwable $e) {
32    // DivisionByZeroError 以外の、その他の予期せぬエラーを捕捉する一般的なcatchブロックです。
33    echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
34}
35
36echo "\nプログラムは正常に続行されました。\n";
37
38?>

このPHPコードは、PHP 8以降で発生する「ゼロによる除算エラー（DivisionByZeroError）」を捕捉し、そのエラーメッセージを取得する方法を解説しています。

performDivision関数は、二つの整数の除算を試みる関数です。PHP 8以降では、この関数で除数にゼロを指定すると、自動的にDivisionByZeroErrorがスローされます。

プログラムはtry-catchブロックを使用し、このエラーを安全に捕捉しています。tryブロック内でゼロ除算を試み、エラーが発生すると、catch (DivisionByZeroError $e)ブロックがそのエラーを処理します。

$e->getMessage()は、捕捉したDivisionByZeroErrorオブジェクトから、エラーに関する簡潔な説明文字列を返すメソッドです。このメソッドは引数を必要とせず、エラーの根本原因（例えば「Division by zero」）を直接的に示す文字列を戻り値として提供します。このメッセージは通常、途中で切り詰められる（truncated）ことなく、エラーの完全な情報を含んでいます。

このようにgetMessage()を用いることで、エラー発生時にその内容を具体的に把握し、適切なログ記録やユーザーへの通知が可能になります。これにより、プログラムが異常終了することなく、制御された形で処理を続行できるようになります。