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

messageプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

『messageプロパティは、例外に関する詳細な説明文を保持するプロパティです』 このプロパティは、OutOfRangeExceptionクラスが継承している基底のExceptionクラスで定義されています。OutOfRangeExceptionは、配列の範囲外のインデックスにアクセスしようとした場合など、値が有効な範囲を超えたときにスローされる例外です。この例外が発生した際、messageプロパティには、なぜエラーが発生したのかを説明する具体的なメッセージが文字列として格納されます。例えば、「Index invalid or out of range」のような内容が含まれます。このプロパティはprotectedとして宣言されているため、オブジェクトの外部から直接アクセスすることはできません。値を取得するためには、公開されているgetMessage()メソッドを使用する必要があります。try-catchブロックでOutOfRangeExceptionを捕捉した際に、このgetMessage()メソッドを呼び出すことで、エラーの原因を特定し、ログに記録したり、デバッグに役立てたりすることが可能です。開発者はこのメッセージ情報を利用して、プログラムの不具合を修正するための重要な手がかりを得ることができます。

構文(syntax)

1<?php
2
3try {
4    $array = new \SplFixedArray(2);
5    // 範囲外のインデックスにアクセスすると OutOfRangeException がスローされます。
6    $array[2] = 'value';
7} catch (\OutOfRangeException $e) {
8    // Exception::getMessage() メソッドを介して message プロパティの値を取得します。
9    echo $e->getMessage();
10}
11
12?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

OutOfRangeException::message プロパティは、例外が発生した理由を人間が読める形式の文字列で返します。

関連コンテンツ

関連プログラミング言語