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

getMessageメソッドは、スローされたUnexpectedValueExceptionオブジェクトから、例外メッセージの文字列を取得するメソッドです。UnexpectedValueExceptionは、値が期待される型や形式の集合と一致しない場合に発生する例外です。例えば、関数がある特定のパターンの文字列を期待しているにもかかわらず、全く異なるパターンの文字列が渡された場合などに使用されます。例外が生成される際、通常はその原因を説明するための具体的なメッセージが設定されます。getMessageメソッドを呼び出すことで、この設定されたメッセージ文字列を取り出すことができます。この機能は、プログラムのデバッグやエラー処理において非常に重要な役割を果たします。具体的には、try...catch構文でUnexpectedValueExceptionを捕捉した際に、このメソッドを使ってエラーメッセージを取得し、ログファイルに記録したり、開発者向けにエラー内容を表示したりすることで、問題の原因を迅速に特定するのに役立ちます。このメソッドはPHPの全ての例外の基底クラスであるExceptionクラスで定義されており、UnexpectedValueExceptionはそれを継承しているため利用可能です。

Copy
1<?php
2
3try {
4    // 予期しない値を持つ例外を意図的に発生させます。
5    throw new UnexpectedValueException("処理の途中で予期しない値が見つかりました。");
6} catch (UnexpectedValueException $e) {
7    // 捕捉した例外オブジェクトからメッセージを取得して表示します。
8    echo $e->getMessage();
9}
10
11?>

引数なし

引数はありません

string

例外発生時のエラーメッセージを文字列として返します。