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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 配列から指定されたインデックスの要素を取得します。
7 * インデックスが存在しない場合は OutOfBoundsException をスローします。
8 *
9 * @param array<int, string> $items 検索対象の配列
10 * @param int $index 取得したい要素のインデックス
11 * @return string 指定されたインデックスの要素
12 * @throws OutOfBoundsException インデックスが配列の範囲外の場合
13 */
14function getItem(array $items, int $index): string
15{
16    if (!isset($items[$index])) {
17        // インデックスが存在しない場合、エラーメッセージを指定して例外をスローする
18        throw new OutOfBoundsException("インデックス {$index} は範囲外です。");
19    }
20    return $items[$index];
21}
22
23$colors = ['red', 'green', 'blue'];
24$targetIndex = 5; // 存在しないインデックスを指定
25
26try {
27    // 範囲外のインデックスにアクセスしようと試みる
28    $color = getItem($colors, $targetIndex);
29    echo "取得した色: " . $color . PHP_EOL;
30} catch (OutOfBoundsException $e) {
31    // OutOfBoundsException がスローされた場合、ここでキャッチする
32
33    // $e->getMessage() を使って、例外オブジェクトに設定されたエラーメッセージを取得・表示する
34    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
35}

OutOfBoundsExceptionクラスに所属するgetMessage()メソッドは、スロー（発生）された例外オブジェクトから、エラーメッセージの文字列を取得するために使用します。このメソッドは引数を取らず、戻り値としてstring型の文字列を返します。この文字列は、例外が作成される際にコンストラクタに渡された、具体的なエラー内容です。

サンプルコードでは、まずgetItemという関数を定義しています。この関数は、引数で受け取った配列に指定されたインデックスが存在しない場合、「インデックス {$index} は範囲外です。」というメッセージを持つOutOfBoundsExceptionをthrow（スロー）します。

次に、try...catchブロックを使用して例外処理を行っています。tryブロック内で、存在しないインデックス（5）を指定してgetItem関数を呼び出すと、OutOfBoundsExceptionが発生します。すると、プログラムの実行は直ちにcatchブロックに移ります。

catchブロックでは、発生した例外オブジェクトが変数$eに格納されます。そして、$e->getMessage()を呼び出すことで、例外がスローされた際に設定された「インデックス 5 は範囲外です。」というエラーメッセージを取得し、画面に出力しています。このようにgetMessage()は、プログラムが予期せぬエラーで停止した際に、その原因をユーザーや開発者に分かりやすく伝えるために重要な役割を果たします。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 配列から指定されたインデックスの要素を取得します。
7 *
8 * @param array<int, string> $items 検索対象の配列
9 * @param int $index 取得したい要素のインデックス
10 * @return string 指定されたインデックスの要素
11 * @throws OutOfBoundsException 指定されたインデックスが存在しない場合にスローされます。
12 */
13function getElement(array $items, int $index): string
14{
15    // 配列に指定されたインデックスが存在するかチェック
16    if (!isset($items[$index])) {
17        // 存在しない場合、カスタムメッセージを指定して例外をスローする
18        throw new OutOfBoundsException("エラー: インデックス {$index} は範囲外です。");
19    }
20
21    return $items[$index];
22}
23
24// サンプルデータ
25$colors = ['赤', '緑', '青'];
26$invalidIndex = 5;
27
28try {
29    // 存在しないインデックスを指定して関数を呼び出し、意図的に例外を発生させる
30    echo "インデックス {$invalidIndex} の要素を取得しようとします..." . PHP_EOL;
31    $color = getElement($colors, $invalidIndex);
32    echo "取得した色: " . $color . PHP_EOL;
33} catch (OutOfBoundsException $e) {
34    // catchブロックで例外を捕捉する
35    // getMessage()メソッドで、スローされた例外のメッセージ文字列を取得して表示する
36    echo "例外がキャッチされました。" . PHP_EOL;
37    echo "エラーメッセージ: " . $e->getMessage() . PHP_EOL;
38}

OutOfBoundsException::getMessage()メソッドは、発生したOutOfBoundsExceptionオブジェクトが保持しているエラーメッセージの文字列を取得するために使用します。このメソッドに引数はなく、戻り値としてエラーメッセージを表す文字列（string）を返します。

サンプルコードでは、配列の範囲外のインデックスにアクセスしようとして、意図的にOutOfBoundsExceptionを発生させています。getElement関数は、指定されたインデックスが配列に存在しない場合、throw new OutOfBoundsException(...)を用いて、独自のエラーメッセージを持つ例外を生成します。

tryブロック内でこの関数を呼び出すと例外が発生し、処理は直ちにcatchブロックに移ります。catchブロックでは、発生した例外オブジェクトを引数$eで受け取ります。そして、$e->getMessage()を呼び出すことで、例外が生成された際に設定されたメッセージ「エラー: インデックス 5 は範囲外です。」という文字列を取得し、画面に出力しています。このように、getMessage()を利用することで、例外発生時の具体的な原因をユーザーに示したり、ログとして記録したりすることが可能になります。