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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * ファイルの指定された行の内容を取得しようと試み、
7 * 範囲外の行を指定した際に OutOfBoundsException を捕捉するサンプルです。
8 *
9 * @param string $filePath ファイルのパス
10 * @param int $targetLineNumber 取得したい行番号 (1から始まる)
11 * @return void
12 */
13function getFileContentSample(string $filePath, int $targetLineNumber): void
14{
15    // この関数が単体で動作するよう、一時的なサンプルファイルを作成します。
16    // ファイルには3行だけ書き込みます。
17    $content = "Line 1: Hello, PHP!\nLine 2: Exceptions are useful.\nLine 3: End of file.";
18    file_put_contents($filePath, $content);
19
20    try {
21        // file()関数でファイル全体を行ごとの配列として読み込みます。
22        $lines = file($filePath, FILE_IGNORE_NEW_LINES);
23        if ($lines === false) {
24            // ファイル読み込みに失敗した場合
25            throw new RuntimeException("ファイルの読み込みに失敗しました: {$filePath}");
26        }
27
28        // 配列のインデックスは0から始まるため、行番号から1を引きます。
29        $index = $targetLineNumber - 1;
30
31        // 指定された行が配列の範囲外であるかチェックします。
32        if (!isset($lines[$index])) {
33            // 範囲外の場合、意図的に OutOfBoundsException をスローします。
34            // この例外は、配列などのコレクションで無効なキーやインデックスに
35            // アクセスしようとしたことを示すために使われます。
36            throw new OutOfBoundsException("行番号 {$targetLineNumber} は存在しません。");
37        }
38
39        // 成功した場合、内容を表示します。
40        echo "{$targetLineNumber}行目の内容: " . $lines[$index] . PHP_EOL;
41
42    } catch (OutOfBoundsException $e) {
43        // OutOfBoundsException がスローされた場合に、このブロックが実行されます。
44        echo "エラー: " . $e->getMessage() . PHP_EOL;
45
46        // OutOfBoundsException::getFile() メソッドを使用します。
47        // このメソッドは、例外がスローされたファイルへのフルパスを文字列で返します。
48        // このサンプルでは、このPHPファイル自身のパスが表示されます。
49        echo "例外が発生したファイル: " . $e->getFile() . PHP_EOL;
50
51        // getLine() で例外が発生した行番号も取得できます。
52        echo "例外が発生した行番号: " . $e->getLine() . PHP_EOL;
53
54    } finally {
55        // 処理の最後に、作成した一時ファイルを必ず削除します。
56        if (file_exists($filePath)) {
57            unlink($filePath);
58        }
59    }
60}
61
62// サンプル関数を実行します。
63// 3行しかないファイルに対して、存在しない99行目を指定して例外を発生させます。
64getFileContentSample('sample.txt', 99);
65

OutOfBoundsException::getFile()は、例外が発生したファイルの名前とフルパスを取得するためのメソッドです。

このサンプルコードは、テキストファイルから指定された行番号の内容を読み込む関数を定義しています。まず、3行だけのテスト用ファイルを作成します。次に、存在しない99行目を読み込もうとすることで、意図的にOutOfBoundsExceptionという例外を発生させます。この例外は、配列などで範囲外の要素にアクセスしようとしたときに発生するエラーです。

try...catch構文によってこの例外が捕捉されると、catchブロック内の処理が実行されます。ここで$e->getFile()を呼び出しています。このメソッドは引数を取らず、例外がスローされたPHPファイル（このサンプルコード自身）のフルパスを文字列として返します。この戻り値を利用することで、プログラムのどのファイルで問題が起きたのかを正確に特定でき、デバッグ作業に役立ちます。コードの実行結果では、getFile()によって取得されたファイルパスが表示されます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * file_get_contents() で読み込んだデータ処理中に発生する例外を捕捉するデモ。
7 *
8 * この関数は、まず file_get_contents() でファイルからデータを読み込みます。
9 * その後、データを処理する過程で意図的に配列の範囲外にアクセスし、
10 * OutOfBoundsException を発生させます。
11 * catch ブロックでは、例外オブジェクトが持つ getFile() メソッドを使い、
12 * どのファイルでエラーが起きたかを表示します。
13 *
14 * @return void
15 */
16function processFileData(): void
17{
18    // デモで使用する一時ファイル名
19    $filename = 'sample_data.txt';
20
21    // デモ用のデータファイルを作成します。内容は2つの要素のみです。
22    file_put_contents($filename, 'Apple,Banana');
23
24    try {
25        // キーワードである file_get_contents() を使用してファイルの内容を読み込みます。
26        $content = file_get_contents($filename);
27        if ($content === false) {
28            // 実際には、ファイルが読み込めない場合のエラー処理が必要です。
29            return;
30        }
31
32        // 読み込んだ文字列をカンマで分割して配列にします。
33        $items = explode(',', $content);
34
35        // PHPの標準配列と異なり、SplFixedArray は固定長の配列を扱います。
36        // 範囲外のインデックスにアクセスすると、エラーではなく例外 (OutOfBoundsException) をスローします。
37        $fixedArray = SplFixedArray::fromArray($items);
38
39        // 配列の範囲外 (0: Apple, 1: Banana) であるインデックス 2 にアクセスします。
40        // ここで OutOfBoundsException がスローされ、catch ブロックに処理が移ります。
41        $item = $fixedArray[2];
42        echo "取得した要素: " . $item . PHP_EOL;
43
44    } catch (OutOfBoundsException $e) {
45        // 発生した OutOfBoundsException を捕捉します。
46        echo "エラー: データの範囲外にアクセスしようとしました。" . PHP_EOL;
47        echo "------------------------------------------------" . PHP_EOL;
48
49        // OutOfBoundsException::getFile() メソッドを使用し、
50        // 例外が発生した「スクリプトファイル名」を取得して表示します。
51        // これにより、大規模な開発でもエラーの発生箇所を正確に特定できます。
52        echo "  発生ファイル: " . $e->getFile() . PHP_EOL;
53        echo "  発生行番号: " . $e->getLine() . PHP_EOL;
54        echo "  エラー詳細: " . $e->getMessage() . PHP_EOL;
55        echo "------------------------------------------------" . PHP_EOL;
56
57    } finally {
58        // try-catch の処理が終わった後、作成した一時ファイルを必ず削除します。
59        if (file_exists($filename)) {
60            unlink($filename);
61        }
62    }
63}
64
65// 関数を実行します。
66processFileData();
67

OutOfBoundsException::getFile()メソッドは、配列などの範囲外にアクセスしようとした際に発生するOutOfBoundsExceptionという例外が、どのファイルで起きたかを特定するためのメソッドです。

このメソッドは引数を必要としません。戻り値として、例外が発生したPHPスクリプトのファイル名をフルパスで文字列（string）として返します。

サンプルコードでは、まずfile_get_contents()関数でファイルからデータを読み込み、固定長の配列に格納します。tryブロック内で、意図的に配列の要素数を超えるインデックスにアクセスすることでOutOfBoundsExceptionを発生させています。

続くcatchブロックでこの例外を捕捉し、例外オブジェクト変数（$e）に対して$e->getFile()を実行しています。これにより、エラーが発生したファイル名が文字列として取得され、画面に出力されます。この機能は、特に複数のファイルが連携する複雑なシステムにおいて、エラーの発生箇所を迅速に特定するのに役立ちます。