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

getMessageメソッドは、InvalidArgumentExceptionオブジェクトに設定された例外メッセージを取得するために使用されるメソッドです。このメソッドは、PHPの基本的な例外クラスであるExceptionクラスから継承されており、例外処理において重要な役割を担います。InvalidArgumentExceptionは、関数やメソッドに渡された引数の型や値が期待されるものと異なっている、つまり引数が不正である場合にスローされる例外です。例えば、数値を期待する引数に文字列が渡された場合などに発生します。例外がスローされる際、コンストラクタを通じて「引数は正の数でなければなりません」といった、エラーの原因を説明する具体的なメッセージが設定されることが一般的です。getMessageメソッドは、この設定されたエラーメッセージを文字列として取得するために使用されます。try-catchブロックでInvalidArgumentExceptionを捕捉した際に、このメソッドを呼び出すことで、エラーの詳細な理由をプログラムで取得できます。取得したメッセージは、ログファイルへの記録やデバッグ情報の表示に利用され、問題の迅速な特定と解決に役立ちます。

Copy
1<?php
2
3try {
4    throw new InvalidArgumentException("引数が無効です。");
5} catch (InvalidArgumentException $e) {
6    // 例外メッセージを取得します
7    $errorMessage = $e->getMessage();
8    echo $errorMessage;
9}

引数なし

引数はありません

string

このメソッドは、例外が発生した理由を説明する文字列を返します。