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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 設定ファイルから特定行のデータを読み込む処理をシミュレートします。
7 *
8 * このサンプルでは、file_exists() を使ってファイルの存在を確認し、
9 * ファイルが存在しない場合に、範囲外アクセスを模倣して
10 * OutOfBoundsException を意図的に発生させます。
11 *
12 * @param string $filePath 設定ファイルのパス
13 * @throws OutOfBoundsException ファイルが存在しない、または行が範囲外の場合にスロー
14 */
15function loadSettingFromFile(string $filePath): void
16{
17    // キーワード `file_exists` を使用して、ファイルの存在を事前に確認します。
18    if (!file_exists($filePath)) {
19        // ファイルが存在しない場合は処理を中断し、例外をスローします。
20        // ここでは OutOfBoundsException のデモとして、
21        // 空の固定長配列にアクセスし、意図的に例外を発生させます。
22        $dummyArray = new SplFixedArray(0);
23        $dummyArray[0] = 'trigger exception'; // 範囲外アクセス
24    }
25
26    // 実際には、この後にファイル読み込みとデータ処理が続きます。
27    echo "ファイル '{$filePath}' は正常に存在します。\n";
28}
29
30// 存在しないファイル名を指定します。
31$nonExistentFile = 'non_existent_settings.ini';
32
33try {
34    // 設定ファイルを読み込む関数を実行します。
35    loadSettingFromFile($nonExistentFile);
36} catch (OutOfBoundsException $e) {
37    // OutOfBoundsException がスローされた場合、ここで捕捉します。
38    echo "エラー: 処理中に例外が発生しました。\n";
39    echo "メッセージ: " . $e->getMessage() . "\n";
40
41    // OutOfBoundsException オブジェクトが持つプロパティ `file` の値を取得します。
42    // getFile() メソッドを通じて、例外が発生したファイル名を知ることができます。
43    echo "発生ファイル: " . $e->getFile() . "\n";
44    echo "発生行番号: " . $e->getLine() . "\n";
45}

PHPのOutOfBoundsExceptionクラスは、例外が発生したプログラムのファイル名を取得するためのfileプロパティを備えています。このプロパティの値は、getFile()メソッドを呼び出すことで取得できます。getFile()メソッドに引数はなく、戻り値として例外が発生したファイルのフルパスが文字列（string）で返されます。

サンプルコードでは、まずloadSettingFromFile関数が、キーワードであるfile_exists()関数を使ってファイルの存在を確認します。ファイルが存在しない場合、この関数は意図的に配列の範囲外へアクセスし、OutOfBoundsExceptionを発生させます。

try...catchブロックでこの例外を捕捉し、catchブロック内で$e->getFile()を実行しています。これにより、例外がスローされたPHPファイルの名前を取得し、画面に出力しています。このようにgetFile()は、getMessage()（エラーメッセージ）やgetLine()（行番号）と組み合わせることで、プログラムのどこで問題が起きたのかを正確に特定し、デバッグ作業を助ける重要な機能です。

Copy
1<?php
2
3/**
4 * file_get_contentsで読み込んだデータに対し、範囲外アクセスを試みることで
5 * OutOfBoundsExceptionを発生させ、例外からファイル名を取得するサンプルです。
6 */
7function demonstrateFilePropertyInException(): void
8{
9    $filename = 'sample_data.txt';
10
11    // テスト用のファイルを作成します
12    file_put_contents($filename, "line1\nline2\nline3");
13
14    try {
15        // file_get_contents() でファイルの内容を文字列として取得します
16        $contents = file_get_contents($filename);
17        if ($contents === false) {
18            // ファイル読み込み失敗時の処理
19            throw new Exception("ファイルの読み込みに失敗しました: {$filename}");
20        }
21
22        // 読み込んだ内容を行ごとの配列に分割します
23        $lines = explode("\n", $contents);
24        $lineCount = count($lines); // この場合、行数は3
25
26        // 意図的に配列の範囲外のインデックスを指定します
27        $outOfBoundsIndex = 10;
28
29        // 範囲外アクセスを試み、OutOfBoundsExceptionをスローします
30        if (!isset($lines[$outOfBoundsIndex])) {
31            throw new OutOfBoundsException("インデックス {$outOfBoundsIndex} は範囲外です。");
32        }
33    } catch (OutOfBoundsException $e) {
34        // 例外をキャッチし、情報を表示します
35        echo "エラーメッセージ: " . $e->getMessage() . PHP_EOL;
36
37        // OutOfBoundsExceptionオブジェクトの getFile() メソッド（fileプロパティ）を使い、
38        // 例外が発生したファイル名を取得します。
39        echo "エラーが発生したファイル: " . $e->getFile() . PHP_EOL;
40        echo "エラーが発生した行番号: " . $e->getLine() . PHP_EOL;
41    } finally {
42        // 処理の成功・失敗にかかわらず、後片付けとしてファイルを削除します
43        if (file_exists($filename)) {
44            unlink($filename);
45        }
46    }
47}
48
49// 関数を実行します
50demonstrateFilePropertyInException();

このPHPサンプルコードは、OutOfBoundsExceptionという例外が発生した際に、そのエラーがどのファイルで起きたかを取得する方法を示しています。OutOfBoundsExceptionは、配列などで存在しないインデックス（範囲外の添字）にアクセスしようとしたときに発生するエラーです。

コードでは、まずfile_get_contents()関数を使ってファイルの内容を読み込み、行ごとの配列に変換します。次に、tryブロック内で意図的にその配列の範囲外のインデックスを指定し、OutOfBoundsExceptionを発生させています。

catchブロックでは、発生した例外オブジェクト$eを受け取ります。このオブジェクトが持つgetFile()メソッドを呼び出すと、例外が発生したPHPスクリプトのファイル名を文字列として取得できます。このメソッドは引数を取らず、戻り値としてファイルパスの文字列を返します。サンプルでは、このgetFile()に加えてgetMessage()（エラーメッセージ）やgetLine()（行番号）も使い、エラーの詳細情報を表示しています。このように、例外オブジェクトからファイル名や行番号を取得する機能は、エラーの原因を特定するデバッグ作業で非常に役立ちます。