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

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

作成日: 更新日:

基本的な使い方

getMessageメソッドは、例外が発生した際に設定されたエラーメッセージを取得する処理を実行するメソッドです。このメソッドは、PHPの基本的な例外クラスであるExceptionクラスで定義されており、LengthExceptionクラスはこれを継承することで利用します。LengthExceptionは、主に文字列や配列などの長さが不正であることを示すエラーが発生した際にスローされる例外です。例外を生成する際、new LengthException('長さが5文字以上でなければなりません') のように、コンストラクタの第一引数にエラーの詳細を説明する文字列を渡します。その後、try...catch構文でこの例外オブジェクトを捕捉し、そのオブジェクトに対してgetMessageメソッドを呼び出すと、コンストラクタで設定したエラーメッセージ文字列が返されます。この返されたメッセージは、エラーログに記録したり、画面に表示したりすることで、開発者がエラーの原因を迅速に特定し、デバッグ作業を行う上で重要な役割を果たします。なお、このメソッドはfinalとして宣言されているため、継承先のクラスで処理を上書きすることはできません。

構文(syntax)

1<?php
2
3try {
4    $data = "too short";
5    if (strlen($data) < 20) {
6        // 長さが不適切な場合に LengthException をスローします。
7        throw new LengthException("データは20文字以上である必要があります。");
8    }
9} catch (LengthException $e) {
10    // catchした例外オブジェクトから、設定されたエラーメッセージを取得して表示します。
11    echo $e->getMessage();
12}
13
14?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

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

関連コンテンツ

関連プログラミング言語