【PHP8.x】OutOfBoundsException::messageプロパティの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * OutOfBoundsException を捕捉し、そのメッセージを
7 * JavaScript のアラートダイアログ（メッセージボックス）で表示するサンプルです。
8 */
9function showAlertForOutOfBoundsException(): void
10{
11    try {
12        // 配列を定義します
13        $fruits = ['apple', 'banana', 'orange'];
14
15        // 存在しないインデックス（キー）にアクセスして、意図的に例外を発生させます。
16        // このような配列の範囲外アクセスは OutOfBoundsException の一例です。
17        // ここでは、動作を明確にするために明示的に例外をスローします。
18        $index = 3;
19        if (!isset($fruits[$index])) {
20            throw new OutOfBoundsException("指定されたインデックス {$index} は存在しません。");
21        }
22        // 本来はこのインデックスを使った処理が続く
23        // echo $fruits[$index];
24
25    } catch (OutOfBoundsException $e) {
26        // tryブロック内で OutOfBoundsException が発生した場合、このcatchブロックが実行されます。
27
28        // $e->getMessage() を使って、例外に設定されたエラーメッセージ（string）を取得します。
29        // これは OutOfBoundsException クラスが継承している Exception クラスの機能です。
30        $errorMessage = $e->getMessage();
31
32        // XSS(クロスサイトスクリプティング)脆弱性を防ぐため、
33        // メッセージをJavaScriptで安全に表示できるようにエンコードします。
34        $encodedMessage = json_encode(
35            $errorMessage,
36            JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT
37        );
38
39        // JavaScript の alert() を使って、ブラウザにメッセージボックスを表示します。
40        // PHPはサーバーサイドで動作するため、このようにHTML/JavaScriptを出力することで
41        // ブラウザ側でダイアログを表示させることができます。
42        echo "<script>alert({$encodedMessage});</script>";
43    }
44}
45
46// 関数を実行して、メッセージボックスを表示します
47showAlertForOutOfBoundsException();

このPHPコードは、OutOfBoundsExceptionというエラーが発生した際に、そのエラーメッセージをブラウザのメッセージボックスに表示する方法を示します。OutOfBoundsExceptionは、配列などで範囲外のキー（インデックス）を指定して値を取得しようとしたときなどに発生する実行時エラーです。

サンプルコードでは、tryブロック内で意図的にこの例外を発生させ、catchブロックで捕捉しています。捕捉した例外オブジェクト（変数$e）に対して$e->getMessage()を呼び出すことで、例外に設定されたエラーメッセージを取得できます。getMessage()メソッドは、PHPの基本的なExceptionクラスから継承された機能で、引数は必要ありません。戻り値として、エラーの詳細を説明する文字列（string）が返されます。

最後に、取得したメッセージ文字列をecho文でJavaScriptのalert()関数へ渡し、ブラウザ上でメッセージボックスとして表示しています。このようにして、プログラムの実行中に発生した問題の詳細をユーザーに通知することができます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * シンプルなメッセージキューを表現するクラス
7 */
8final class SimpleMessageQueue
9{
10    /**
11     * @var array<int, string> キューに格納されたメッセージの配列
12     */
13    private array $queue = [];
14
15    /**
16     * メッセージをキューの末尾に追加します。
17     *
18     * @param string $message 追加するメッセージ
19     */
20    public function enqueue(string $message): void
21    {
22        $this->queue[] = $message;
23        echo "メッセージを追加しました: '{$message}'" . PHP_EOL;
24    }
25
26    /**
27     * メッセージをキューの先頭から取り出します。
28     *
29     * @return string キューの先頭のメッセージ
30     * @throws OutOfBoundsException キューが空の場合
31     */
32    public function dequeue(): string
33    {
34        // キューが空かどうかを確認する
35        if (empty($this->queue)) {
36            // キューが空の場合、範囲外アクセスとしてOutOfBoundsExceptionをスローする
37            throw new OutOfBoundsException("メッセージキューは空です。これ以上メッセージを取り出せません。");
38        }
39
40        // 配列の先頭から要素を取り出して返す (FIFO)
41        return array_shift($this->queue);
42    }
43}
44
45// メッセージキューのインスタンスを作成
46$messageQueue = new SimpleMessageQueue();
47
48// キューにメッセージを追加
49$messageQueue->enqueue("タスクA: ユーザー登録処理");
50$messageQueue->enqueue("タスクB: 通知メール送信");
51echo "---" . PHP_EOL;
52
53try {
54    // キューからメッセージを順番に取り出す
55    $task1 = $messageQueue->dequeue();
56    echo "メッセージを取り出しました: '{$task1}'" . PHP_EOL;
57
58    $task2 = $messageQueue->dequeue();
59    echo "メッセージを取り出しました: '{$task2}'" . PHP_EOL;
60
61    // キューは空になったはずなので、もう一度取り出しを試みる
62    // これによりOutOfBoundsExceptionが発生する
63    echo "再度メッセージの取り出しを試みます..." . PHP_EOL;
64    $messageQueue->dequeue();
65
66} catch (OutOfBoundsException $e) {
67    // スローされた例外を捕捉する
68    // OutOfBoundsExceptionクラスが持つ`message`プロパティの値をgetMessage()で取得して表示
69    echo "エラーを捕捉しました。" . PHP_EOL;
70    echo "例外クラス: " . get_class($e) . PHP_EOL;
71    echo "エラーメッセージ: " . $e->getMessage() . PHP_EOL;
72}

このPHPサンプルコードは、シンプルなメッセージキューを実装し、キューが空の状態でデータを取り出そうとした際に発生するエラー処理を示しています。ここで使用されているOutOfBoundsExceptionは、配列などの集合データにおいて、範囲外の要素へアクセスしようとしたことを示すための、PHPに標準で用意されている例外クラスです。

dequeueメソッド内では、キューが空の場合にnew OutOfBoundsException("メッセージキューは空です...")という形で、エラーメッセージをコンストラクタの引数に渡して例外オブジェクトを生成し、throwしています。このコンストラクタに渡された文字列が、OutOfBoundsExceptionオブジェクトが内部に持つmessageプロパティに保存されます。

try...catchブロックは、この発生した例外を捕捉するために使われます。catchブロックで受け取った例外オブジェクト（変数 $e）のgetMessage()メソッドを呼び出すことで、messageプロパティに格納されたエラーメッセージ文字列を取得できます。getMessage()メソッドは引数を取らず、戻り値としてmessageプロパティの値である文字列（string）を返します。この仕組みにより、エラーが発生した具体的な原因をプログラムの実行者に伝えることが可能になります。