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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 配列の範囲外アクセスで発生する OutOfBoundsException を捕捉し、
7 * __toString() メソッドで例外情報を文字列として表示するサンプルクラスです。
8 */
9class ArrayAccessExample
10{
11    /**
12     * サンプルを実行します。
13     */
14    public function run(): void
15    {
16        // 固定長の配列を生成します (サイズ: 3)。
17        // 有効なインデックスは 0, 1, 2 です。
18        $fruits = new SplFixedArray(3);
19        $fruits[0] = 'Apple';
20        $fruits[1] = 'Banana';
21        $fruits[2] = 'Cherry';
22
23        try {
24            // 存在しないインデックス (3) にアクセスを試みます。
25            // これにより OutOfBoundsException がスローされます。
26            echo 'インデックス 3 のフルーツ: ' . $fruits[3] . PHP_EOL;
27        } catch (OutOfBoundsException $e) {
28            // 例外が捕捉された場合、その内容を文字列として出力します。
29            // echo に例外オブジェクトを渡すと、内部的に __toString() メソッドが自動で呼び出され、
30            // 例外に関する情報（クラス名、メッセージ、ファイル、行番号など）が
31            // 整形された文字列として返されます。
32            echo "エラーが発生しました:" . PHP_EOL;
33            echo $e;
34        }
35    }
36}
37
38// クラスのインスタンスを生成して実行します
39$example = new ArrayAccessExample();
40$example->run();

このPHPサンプルコードは、OutOfBoundsExceptionクラスに定義されている__toString()メソッドの動作を解説するものです。OutOfBoundsExceptionは、配列などで定義された範囲外のインデックス（添え字）にアクセスしようとした際に発生する例外です。

コードでは、まずSplFixedArrayを使ってサイズが3の固定長配列を作成しています。この配列で有効なインデックスは0、1、2のみです。次にtryブロック内で、存在しないインデックスである3に意図的にアクセスし、OutOfBoundsExceptionを発生させています。

続くcatchブロックでは、発生した例外オブジェクトを$eという変数で捕捉しています。ここでecho $e;のように例外オブジェクトを直接出力しようとすると、PHPの内部で自動的に__toString()メソッドが呼び出されます。このメソッドは引数を持たず、例外に関する詳細情報（クラス名、メッセージ、発生ファイル、行番号など）を人間が読みやすい形式に整形した文字列（string）を戻り値として返します。結果として、コンソールにはエラーの詳細が分かりやすく表示され、デバッグ作業に役立ちます。

Copy
1<?php
2
3/**
4 * 存在しない配列のキーにアクセスしようとしたときに発生する
5 * OutOfBoundsException を捕捉し、その内容を文字列として出力するサンプルです。
6 */
7function demonstrateOutOfBoundsExceptionToString(): void
8{
9    // 3つの要素を持つ配列を定義します。有効なインデックスは 0, 1, 2 です。
10    $userList = [
11        100 => 'Taro',
12        101 => 'Jiro',
13        102 => 'Saburo',
14    ];
15
16    // 存在しないインデックス（キー）を指定します。
17    $invalidId = 999;
18
19    try {
20        // 配列に指定したキーが存在するかチェックします。
21        if (!array_key_exists($invalidId, $userList)) {
22            // キーが存在しない場合、OutOfBoundsExceptionを意図的にスローします。
23            throw new OutOfBoundsException("User ID '{$invalidId}' not found.");
24        }
25        // 本来ここで行う処理（今回は例外発生のため実行されない）
26        // echo $userList[$invalidId];
27
28    } catch (OutOfBoundsException $e) {
29        // catchブロックで例外オブジェクト ($e) を捕捉します。
30        echo "エラーが発生しました。詳細:\n";
31        
32        // 例外オブジェクトを直接echoすると、__toString()メソッドが暗黙的に呼び出されます。
33        // これにより、例外クラス名、メッセージ、スタックトレースなどが
34        // 整形された文字列として出力され、デバッグに役立ちます。
35        echo $e;
36    }
37}
38
39demonstrateOutOfBoundsExceptionToString();

このPHPサンプルコードは、OutOfBoundsExceptionクラスが持つ__toStringメソッドの動作を具体的に示しています。__toStringメソッドは、オブジェクトを文字列として扱おうとした際に自動的に呼び出され、そのオブジェクトの情報を表す文字列を返します。このメソッドは引数を取りません。

コードでは、まず$userListという連想配列を定義しています。次にtryブロック内で、array_key_exists関数を用いて配列内に存在しないキー$invalidIdがあるかを確認し、存在しない場合にOutOfBoundsExceptionを意図的に発生させています。

プログラムの流れがcatchブロックに移ると、発生した例外は変数$eにオブジェクトとして格納されます。ここでecho $e;を実行すると、PHPの内部で$e->__toString()メソッドが暗黙的に呼び出されます。その結果、戻り値として例外クラス名、コンストラクタで設定したエラーメッセージ、そしてエラーが発生したファイル名や行番号といったスタックトレース情報が整形された文字列として出力されます。このように例外オブジェクトを直接出力するだけで詳細なエラー情報を確認できるため、デバッグ作業に非常に役立ちます。