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

『messageプロパティは、例外に関する説明的なメッセージ文字列を保持するプロパティです』

このプロパティは、PHPの基本的な例外クラスであるExceptionクラスで定義されており、BadMethodCallExceptionはそれを継承しています。そのため、BadMethodCallExceptionを含む全ての例外オブジェクトがこのmessageプロパティを持っています。BadMethodCallExceptionは、存在しないメソッドを呼び出そうとした場合など、メソッドの呼び出しが不正な状況で発生します。その際に、なぜ例外が発生したのかを具体的に説明する情報、例えば「Call to undefined method ClassName::methodName()」のようなエラーメッセージが、このmessageプロパティに文字列として格納されます。

プログラム開発者は、try-catch構文を用いてこの例外を捕捉し、getMessage()メソッドを通じてmessageプロパティの値を取得できます。取得したエラーメッセージをログファイルに記録したり、画面に表示したりすることで、プログラムのどこで何が問題だったのかを迅速に特定し、デバッグ作業を効率的に進めることが可能になります。このように、messageプロパティは、例外発生時の原因を開発者が理解するための重要な情報源として機能します。

Copy
1<?php
2
3try {
4    // BadMethodCallExceptionを意図的にスローします。
5    throw new BadMethodCallException("未定義のメソッドが呼び出されました。");
6} catch (BadMethodCallException $e) {
7    // getMessage() メソッドを介して message プロパティの値を取得します。
8    $errorMessage = $e->getMessage();
9    echo $errorMessage;
10}
11
12?>

引数なし

引数はありません

string

このプロパティ message は、BadMethodCallException が発生した原因を説明する文字列を返します。