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

messageプロパティは、例外に関する詳細な説明文を保持するプロパティです。このプロパティはLengthExceptionクラスが直接定義したものではなく、その基底クラスであるExceptionクラスから継承されています。そのため、PHPにおける多くの例外クラスで共通して利用される重要な要素です。messageプロパティの役割は、なぜ例外が発生したのか、その具体的な理由を人間が読んで理解できる文字列として格納することです。例えば、関数の引数として渡された配列の要素数が不正である場合に「要素数は5以上でなければなりません」といったエラーメッセージが設定されます。この値は、new LengthException()のようにして例外オブジェクトのインスタンスを生成する際、コンストラクタの第一引数に文字列を渡すことで設定されます。プロパティ自体は外部から直接アクセスできないprotectedなメンバーですが、公開されているgetMessage()メソッドを呼び出すことで、いつでもその値を取得できます。プログラムのデバッグ時やエラーログを記録する際にこのメッセージを取得することで、開発者はエラーの原因を迅速に特定するための重要な手がかりを得ることができます。

Copy
1<?php
2try {
3    // 長さが無効な場合にスローされる例外
4    throw new LengthException("無効な長さが指定されました。");
5} catch (LengthException $e) {
6    // 例外オブジェクトからエラーメッセージを取得して表示します
7    echo $e->getMessage();
8}

引数なし

引数はありません

string

LengthException クラスの message プロパティは、例外が発生した理由を示す文字列を返します。