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

getMessageメソッドは、UnderflowExceptionオブジェクトに設定された例外メッセージを取得する処理を実行するメソッドです。このメソッドは、PHPのすべての例外クラスの基底となるExceptionクラスで定義されており、UnderflowExceptionクラスはこれを継承して利用します。そのため、他の多くの例外クラスでも同じように使用することが可能です。UnderflowExceptionは、空の配列やキューのようなコンテナから要素を取り出そうとするなど、不正なアンダーフロー操作が行われた際にスローされる実行時例外です。例外がスローされる際、通常はその原因を説明する具体的なメッセージ文字列がコンストラクタに渡されます。try-catch構文のcatchブロックでUnderflowExceptionオブジェクトを補足した際に、このgetMessageメソッドを呼び出すことで、その設定されたエラーメッセージ文字列を取得できます。取得したメッセージは、プログラムのデバッグ時にエラーの原因を特定したり、エラーログに記録したり、あるいはユーザーにエラー内容を通知したりするために広く利用されます。このメソッドに引数はなく、戻り値は例外メッセージを表す文字列です。

Copy
1<?php
2try {
3    // UnderflowExceptionを意図的にスローします。
4    throw new UnderflowException("コンテナが空です。");
5} catch (UnderflowException $e) {
6    // 例外オブジェクトからメッセージを取得して出力します。
7    echo $e->getMessage();
8}
9?>

引数なし

引数はありません

string

このメソッドは、例外が発生した際に記録されたエラーメッセージを文字列として返します。