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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * OutOfRangeExceptionを捕捉し、例外発生元のファイル内容を表示するクラス。
7 *
8 * このサンプルは、OutOfRangeException::getFile() メソッドと、キーワード 'getfilecontent' に
9 * 関連する file_get_contents() 関数を組み合わせて使用する例を示します。
10 */
11class ExceptionFileContentReader
12{
13    /**
14     * 意図的に配列の範囲外にアクセスし、OutOfRangeExceptionを発生させます。
15     *
16     * @throws OutOfRangeException 常に発生します。
17     */
18    private function causeException(): void
19    {
20        $sampleArray = ['first', 'second'];
21        // 存在しないインデックス[2]にアクセスして例外をトリガーします。
22        $value = $sampleArray[2];
23    }
24
25    /**
26     * 例外を捕捉し、例外が発生したファイル名とその内容を表示します。
27     */
28    public function displayContentOfExceptionFile(): void
29    {
30        try {
31            // 例外を発生させる可能性のあるメソッドを呼び出します。
32            $this->causeException();
33        } catch (OutOfRangeException $e) {
34            // Exception::getFile() を使用して、例外がスローされたファイルへのフルパスを取得します。
35            $filePath = $e->getFile();
36            echo "例外 (OutOfRangeException) が発生しました。" . PHP_EOL;
37            echo "ファイル: " . $filePath . PHP_EOL;
38            echo "行番号: " . $e->getLine() . PHP_EOL . PHP_EOL;
39
40            // file_get_contents() を使用して、そのファイルの内容を読み込みます。
41            // これがキーワード 'getfilecontent' に関連する処理です。
42            if (is_readable($filePath)) {
43                $content = file_get_contents($filePath);
44                echo "--- 上記ファイルの内容 ---" . PHP_EOL;
45                echo $content;
46            } else {
47                echo "エラー: ファイル '{$filePath}' が読み取れませんでした。" . PHP_EOL;
48            }
49        }
50    }
51}
52
53// クラスのインスタンスを作成し、メソッドを実行します。
54$reader = new ExceptionFileContentReader();
55$reader->displayContentOfExceptionFile();

このPHPサンプルコードは、OutOfRangeExceptionが発生した際に、その原因となったファイル名を取得し、さらにそのファイルの内容を表示する方法を解説します。

OutOfRangeExceptionクラスに属するgetFile()メソッドは、例外処理の中で使用されます。このメソッドは引数を取らず、例外がスローされたファイルのフルパスを文字列（string）として返します。これにより、プログラムのどこでエラーが起きたかを正確に特定できます。

コード内では、まず意図的に配列の範囲外にある要素へアクセスすることでOutOfRangeExceptionを発生させています。try-catchブロックでこの例外を捕捉し、catchブロック内で例外オブジェクト$eに対して$e->getFile()を呼び出します。ここで取得したファイルパスを、PHPの標準関数であるfile_get_contents()に渡すことで、例外発生元のファイル自体のソースコードを文字列として読み込みます。

最終的に、このコードは例外が発生したファイル名、行番号、そしてそのファイルの内容全体を画面に出力します。このようにgetFile()とfile_get_contents()を組み合わせることで、エラー発生時の状況をより詳細に把握でき、デバッグ作業の効率化に繋がります。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * OutOfRangeExceptionとgetFile()メソッドの使用例を示す関数
7 * 
8 * この関数は、SplFileObjectを使用してファイルを行単位で扱います。
9 * ファイルの行数を超える行にアクセスしようとするとOutOfRangeExceptionが発生し、
10 * catchブロックで例外がスローされたファイル名を取得して表示します。
11 */
12function demonstrateGetFileMethod(): void
13{
14    // サンプル用のファイル名
15    $filename = 'sample_data.txt';
16
17    // 3行だけのサンプルファイルを作成
18    file_put_contents($filename, "Line 1\nLine 2\nLine 3");
19
20    try {
21        // SplFileObjectは、ファイルを配列のように扱える便利なクラスです
22        $file = new SplFileObject($filename, 'r');
23
24        // わざと範囲外の行（100行目）にアクセスして例外を発生させる
25        // ファイルは3行しかないため、ここでOutOfRangeExceptionがスローされます
26        echo "Trying to seek to line 100...\n";
27        $file->seek(99); // seekは0から始まるため、100行目はインデックス99
28
29        // この行は実行されません
30        echo "Current line: " . $file->current();
31
32    } catch (OutOfRangeException $e) {
33        // 例外をキャッチし、エラー情報を表示します
34        echo "----------------------------------------\n";
35        echo "エラーが発生しました。\n";
36        echo "エラーメッセージ: " . $e->getMessage() . "\n";
37        
38        // OutOfRangeException::getFile() を使って、例外が発生したファイルパスを取得
39        echo "エラーが発生したファイル: " . $e->getFile() . "\n";
40        
41        echo "エラーが発生した行番号: " . $e->getLine() . "\n";
42        echo "----------------------------------------\n";
43    } finally {
44        // スクリプトの終了時にサンプルファイルを削除します
45        if (file_exists($filename)) {
46            unlink($filename);
47            echo "サンプルファイル '{$filename}' は削除されました。\n";
48        }
49    }
50}
51
52// 関数を実行
53demonstrateGetFileMethod();

このPHPコードは、配列などの範囲外にアクセスした際に発生するOutOfRangeExceptionという例外と、その例外オブジェクトが持つgetFile()メソッドの使い方を示すサンプルです。

まず、file_put_contents()関数を使い、3行だけの簡単なテキストファイルを作成します。次にtryブロックの中で、作成したファイルをSplFileObjectで開きます。そして、seek()メソッドを使って意図的にファイルの行数を超える100行目にアクセスしようと試みます。この操作が原因でOutOfRangeExceptionが発生します。

プログラムはcatchブロックに移り、発生した例外を$eという変数で受け取ります。ここで$e->getFile()メソッドを呼び出しています。このメソッドは引数を取らず、例外が発生したPHPスクリプト自体のファイルパスを文字列として返します。このサンプルでは、取得したファイルパスを、エラーメッセージやgetLine()メソッドで取得した行番号とともに表示することで、どこで問題が起きたのかを具体的に示しています。最後にfinallyブロックで後片付けとして作成したファイルを削除します。このようにgetFile()は、デバッグ時にエラーの発生箇所を特定するのに役立ちます。