【PHP8.x】messageプロパティの使い方

『messageプロパティは、例外に関する詳細な説明文を保持するプロパティです』 このプロパティは、PHPの全ての例外クラスの基盤となるExceptionクラスで定義されており、OverflowExceptionクラスもこれを継承しています。そのため、他の多くの例外クラスと同様の役割を持っています。OverflowExceptionがスローされる際、コンストラクタの第一引数として渡されたエラーメッセージの文字列が、このmessageプロパティに格納されます。このメッセージは、プログラム実行中に何が原因で容量のオーバーフローが発生したのかを開発者に伝えるための重要な情報となります。例えば、「データ構造の最大容量を超えました」といった具体的な状況を示すことで、デバッグ作業を効率的に進めることができます。messageプロパティはprotectedとして宣言されているため、オブジェクトの外部から直接アクセスすることはできません。プロパティの値を取得するには、公開されているgetMessage()メソッドを使用します。try...catch構文でOverflowExceptionを捕捉した際に、このメソッドを呼び出すことでエラーメッセージを取得し、ログに出力したり、ユーザーに通知したりする処理を実装するのが一般的です。

Copy
1<?php
2
3try {
4    // OverflowExceptionを意図的にスローし、コンストラクタにメッセージを設定します。
5    throw new OverflowException("データが容量を超えました。");
6} catch (OverflowException $e) {
7    // getMessage()メソッドを使って、保護されたmessageプロパティの値を取得します。
8    echo $e->getMessage();
9}
10
11?>

引数なし

引数はありません

string

このプロパティは、例外が発生した理由を説明する文字列を返します。