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

getMessageメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

getMessageメソッドは、スローされた例外インスタンスに設定されたエラーメッセージを取得する処理を実行するメソッドです。このメソッドはDomainExceptionクラスに固有のものではなく、基底クラスであるExceptionから継承されています。そのため、DomainExceptionだけでなく、PHPにおける多くの例外オブジェクトで共通して使用することが可能です。DomainExceptionは、ある値が定義された有効な範囲や集合(ドメイン)に属していないことを示す論理的なエラーが発生した場合にスローされます。例外をスローする際に、コンストラクタの第一引数としてエラーの詳細を説明するメッセージ文字列を渡すことができ、getMessageメソッドはその文字列を返します。通常はtry...catch構文のcatchブロック内で、捕捉した例外オブジェクトに対してこのメソッドを呼び出します。これにより、エラーログへの記録、デバッグ情報の表示、あるいはユーザーへの通知など、例外発生の原因を特定し、適切に対処するための具体的な情報を得ることができます。このメソッドは引数を取らず、戻り値として文字列型のメッセージを返します。

構文(syntax)

1<?php
2
3try {
4    // 値が定義されたドメインにない場合にスローされる例外
5    throw new DomainException("指定された値は有効なドメインの範囲外です。");
6} catch (DomainException $e) {
7    // 例外オブジェクトからエラーメッセージを取得して出力する
8    echo $e->getMessage();
9}
10
11?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

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