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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定された配列のインデックスから値を取得します。
7 * インデックスが範囲外の場合はOutOfRangeExceptionをスローします。
8 *
9 * @param array $data 対象の配列
10 * @param int   $index 取得する値のインデックス
11 * @return mixed
12 * @throws OutOfRangeException インデックスが配列の範囲外の場合
13 */
14function getValueAtIndex(array $data, int $index): mixed
15{
16    if (!isset($data[$index])) {
17        // インデックスが配列の範囲外であるため、例外をスローします。
18        // コンストラクタの第一引数に、エラーメッセージとして文字列を渡します。
19        throw new OutOfRangeException('指定されたインデックスは範囲外です。');
20    }
21    return $data[$index];
22}
23
24// サンプルの配列
25$colors = ['red', 'green', 'blue'];
26
27try {
28    // わざと範囲外のインデックス（例: 5）を指定して関数を呼び出します。
29    // この呼び出しにより、OutOfRangeExceptionがスローされます。
30    $color = getValueAtIndex($colors, 5);
31    echo '取得した色: ' . $color . PHP_EOL;
32} catch (OutOfRangeException $e) {
33    // スローされた例外をcatchブロックで捕捉します。
34    // getMessage()メソッドを使い、例外オブジェクトに設定されたエラーメッセージを取得して表示します。
35    // 出力: エラー: 指定されたインデックスは範囲外です。
36    echo 'エラー: ' . $e->getMessage() . PHP_EOL;
37}

OutOfRangeExceptionクラスのgetMessage()メソッドは、例外オブジェクトに設定されたエラーメッセージを取得するために使用します。このメソッドに引数はなく、戻り値としてエラーメッセージの文字列（string型）を返します。

サンプルコードでは、まずgetValueAtIndexという関数を定義しています。この関数は、指定された配列のインデックスが存在しない場合、new OutOfRangeException()を使って意図的に例外を発生（スロー）させます。その際、コンストラクタの引数に'指定されたインデックスは範囲外です。'というエラーメッセージを渡しており、これが例外オブジェクト内に保存されます。

次に、try...catchブロックでこの処理を実行します。tryブロック内でわざと範囲外のインデックスを指定して関数を呼び出すと、OutOfRangeExceptionがスローされ、続くcatchブロックでその例外が捕捉されます。捕捉された例外オブジェクトは変数$eに代入されます。最後に$e->getMessage()を呼び出すことで、例外が作られたときに設定されたエラーメッセージを取得し、画面に表示しています。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * OutOfRangeExceptionから取得した長いエラーメッセージを
7 * 短く切り詰めて（truncate）表示するサンプルコードです。
8 */
9function showTruncatedMessageExample(): void
10{
11    try {
12        // 非常に長いエラーメッセージを持つOutOfRangeExceptionを意図的にスローします。
13        // 実際のアプリケーションでは、エラーログやUI表示でメッセージが長すぎると
14        // 可読性が低下したり、レイアウトが崩れたりする問題が発生することがあります。
15        $longMessage = '指定されたインデックスは範囲外です。配列の有効なインデックス範囲は 0 から 9 ですが、'
16            . '100 が指定されました。データソースからの入力値、またはループカウンターの計算処理を確認してください。'
17            . 'この問題のトレースIDは a1b2c3d4-e5f6-7890-1234-567890abcdef です。';
18
19        throw new OutOfRangeException($longMessage);
20    } catch (OutOfRangeException $e) {
21        // Exception::getMessage() を使って、例外オブジェクトからエラーメッセージを取得します。
22        $originalMessage = $e->getMessage();
23        echo "--- 元のメッセージ (getMessage() の戻り値) ---\n";
24        echo $originalMessage . "\n\n";
25
26        // 取得したメッセージが長すぎる場合を想定し、表示用に短く切り詰めます。
27        // mb_strimwidth() を使うと、指定した幅に文字列を丸め、末尾に省略記号を追加できます。
28        $maxLength = 80;
29        $truncatedMessage = mb_strimwidth($originalMessage, 0, $maxLength, '...');
30
31        echo "--- 切り詰め後のメッセージ ---\n";
32        echo $truncatedMessage . "\n";
33    }
34}
35
36// 関数を実行して結果を表示します。
37showTruncatedMessageExample();

OutOfRangeExceptionクラスのgetMessage()メソッドは、発生した例外オブジェクトに格納されているエラーメッセージを取得するために使用されます。このメソッドは、例外の親クラスであるExceptionクラスから継承された機能です。

このメソッドは引数を取らず、戻り値としてエラーメッセージの文字列（string型）を返します。このメッセージは、例外が生成される際に設定されたものです。

サンプルコードでは、tryブロック内で意図的に長いエラーメッセージを持つOutOfRangeExceptionを発生させています。catchブロックでこの例外を捕捉し、$e->getMessage()を呼び出すことで、設定されたエラーメッセージの全文を取得しています。実際のアプリケーション開発では、ログやUIに表示する際、エラーメッセージが長すぎると見づらくなることがあります。そこでこのコードでは、取得したメッセージをmb_strimwidth()関数で適切な長さに切り詰めて（truncateして）表示する、という実用的な使い方を示しています。このようにgetMessage()は、エラーの原因を特定し、利用者に分かりやすく伝えるための基本的な手段となります。