【PHP8.x】InvalidArgumentException::getMessage()メソッドの使い方

Copy
1<?php
2
3/**
4 * ユーザーの年齢を検証する関数。
5 *
6 * @param int $age 検証する年齢
7 * @throws InvalidArgumentException 年齢が負の値の場合にスローされる
8 * @return void
9 */
10function validateUserAge(int $age): void
11{
12    // 引数として受け取った年齢が0未満の場合、不正な引数とみなす
13    if ($age < 0) {
14        // InvalidArgumentExceptionを生成し、エラーメッセージを設定してスローする
15        throw new InvalidArgumentException("年齢には0以上の数値を指定してください。");
16    }
17
18    echo "年齢 {$age}歳 は有効です。" . PHP_EOL;
19}
20
21// try-catch構文で例外処理を実装する
22try {
23    // 正常な値で関数を呼び出す
24    validateUserAge(25);
25
26    // 不正な値（負の数）を渡し、意図的に例外を発生させる
27    validateUserAge(-10);
28
29} catch (InvalidArgumentException $e) {
30    // 発生した例外をcatchブロックで捕捉する
31    // $eにはInvalidArgumentExceptionのインスタンスが格納されている
32
33    // $e->getMessage()メソッドを呼び出し、例外オブジェクトに設定されたエラーメッセージ文字列を取得して表示する
34    echo "エラー: " . $e->getMessage() . PHP_EOL;
35}
36

$e->getMessage()は、発生した例外オブジェクトに格納されているエラーメッセージを取得するためのメソッドです。このメソッドは引数を取らず、戻り値としてエラーメッセージの文字列（string型）を返します。

サンプルコードでは、まずvalidateUserAge関数が定義されています。この関数は、引数$ageが負の値である場合にInvalidArgumentExceptionという種類の例外をthrow（スロー）します。その際、new InvalidArgumentException("年齢には0以上の数値を指定してください。")のように、エラーメッセージを引数に渡して例外オブジェクトを生成しています。

次に、try-catch構文を使って例外処理を行っています。tryブロック内でvalidateUserAge(-10)が実行されると、関数内で例外がスローされ、処理がcatchブロックへ移ります。スローされたInvalidArgumentExceptionのインスタンスは、変数$eに代入されます。

catchブロック内で$e->getMessage()を呼び出すことで、例外が生成されたときに設定された「年齢には0以上の数値を指定してください。」という文字列を取得できます。この結果、コードの実行時にはこのエラーメッセージが画面に出力されます。このように、getMessage()はエラーの原因を具体的に把握するために利用されます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * ユーザーの年齢を検証し、不正な値の場合は例外をスローする関数
7 *
8 * @param int $age 検証する年齢
9 * @return void
10 * @throws InvalidArgumentException 年齢が0未満の場合
11 */
12function validateUserAge(int $age): void
13{
14    // 引数($age)が0未満の場合、不正な引数として例外をスローします。
15    // 例外オブジェクトのコンストラクタに渡した文字列が、エラーメッセージになります。
16    if ($age < 0) {
17        throw new InvalidArgumentException('年齢には0以上の整数を指定してください。');
18    }
19
20    echo "年齢は {$age} 歳で、正常に処理されました。" . PHP_EOL;
21}
22
23try {
24    // 正常な値を渡して関数を呼び出す
25    validateUserAge(30);
26
27    // 不正な値（マイナス値）を渡して、意図的に例外を発生させる
28    validateUserAge(-5);
29} catch (InvalidArgumentException $e) {
30    // catchブロックで InvalidArgumentException を捕捉します。
31    // getMessage() メソッドを使って、例外がスローされた際に設定された
32    // エラーメッセージ（文字列）を取得し、表示します。
33    echo 'エラーが発生しました: ' . $e->getMessage() . PHP_EOL;
34}

InvalidArgumentExceptionクラスに属するgetMessage()メソッドは、発生した例外に設定されているエラーメッセージを取得するためのものです。このメソッドに引数はなく、戻り値としてエラーメッセージの文字列（string）を返します。

サンプルコードでは、validateUserAge関数が引数として受け取った年齢を検証します。年齢が0未満の場合、InvalidArgumentExceptionという種類の例外をthrow（スロー）します。このとき、new InvalidArgumentException('...')のように、例外オブジェクトのコンストラクタに渡された文字列が、その例外固有のエラーメッセージとして設定されます。

try...catchブロックでは、この例外が発生する可能性のある処理を実行します。validateUserAge(-5)が呼び出されると関数内で例外がスローされ、処理は直ちにcatchブロックに移ります。catchブロックは発生した例外を$eという変数で捕捉します。そして、$e->getMessage()を呼び出すことで、先ほど設定されたエラーメッセージ「年齢には0以上の整数を指定してください。」という文字列が取得され、画面に出力されます。このようにgetMessage()は、プログラムでエラーが発生した具体的な原因を把握するために利用されます。