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

Copy
1<?php
2
3/**
4 * 指定された年齢が有効な範囲内にあるか検証します。
5 *
6 * @param int $age 検証する年齢
7 * @return void
8 * @throws RangeException 年齢が0未満または150より大きい場合
9 */
10function validateAge(int $age): void
11{
12    if ($age < 0 || $age > 150) {
13        // 年齢が有効な範囲外の場合、RangeExceptionをスローします。
14        throw new RangeException("年齢は0から150の間でなければなりません。");
15    }
16    echo "年齢 {$age} は有効な範囲内です。" . PHP_EOL;
17}
18
19try {
20    // 意図的に無効な値を渡し、RangeExceptionを発生させます。
21    validateAge(200);
22} catch (RangeException $e) {
23    // スローされたRangeExceptionを捕捉します。
24
25    echo "--- 例外情報 ---" . PHP_EOL;
26    echo "メッセージ: " . $e->getMessage() . PHP_EOL;
27
28    // getFile()メソッドを使い、例外がスローされたファイルへの絶対パスを取得します。
29    // デバッグ時に、どのファイルで問題が起きたかを特定するのに役立ちます。
30    $errorFile = $e->getFile();
31    echo "発生ファイル: " . $errorFile . PHP_EOL;
32
33    // getLine()メソッドで、例外がスローされた行番号を取得します。
34    $errorLine = $e->getLine();
35    echo "発生行: " . $errorLine . PHP_EOL;
36    echo "----------------" . PHP_EOL . PHP_EOL;
37
38    // キーワード 'getfilecontent' に関連する処理です。
39    // getFile() で取得したファイルパスを使い、ファイルの内容(content)を読み込んで、
40    // エラーが発生した箇所周辺のコードを表示します。
41    if (is_readable($errorFile)) {
42        echo "--- エラー箇所のコード ---" . PHP_EOL;
43
44        // file()関数でファイルを行ごとの配列として読み込みます。
45        $lines = file($errorFile);
46
47        // エラー行の前後2行（合計5行）を表示する範囲を計算します。
48        $start = max(0, $errorLine - 3);
49        $end = min(count($lines) - 1, $errorLine + 1);
50
51        for ($i = $start; $i <= $end; $i++) {
52            // エラーが発生した行に印 '>' を付けます。
53            $prefix = ($i + 1 === $errorLine) ? " > " : "   ";
54            // 行番号とコードを表示します。
55            echo sprintf("%s%4d: %s", $prefix, $i + 1, rtrim($lines[$i])) . PHP_EOL;
56        }
57        echo "------------------------" . PHP_EOL;
58    }
59}

RangeException::getFile()は、例外（プログラム実行中のエラー）が発生したファイルの名前を、絶対パス形式の文字列として取得するためのメソッドです。このメソッドに引数は必要ありません。

サンプルコードでは、まずvalidateAgeという関数を定義しています。この関数は、引数で受け取った年齢が0歳未満や150歳より大きい場合に、範囲外のエラーを示すRangeExceptionを意図的に発生させます。

次にtry...catchブロックで、この例外を捕捉しています。catchブロック内では、捕捉した例外オブジェクト（変数$e）に対して$e->getFile()を呼び出しています。これにより、RangeExceptionがthrowされたファイル、つまりこのコードが書かれているファイル自身の絶対パスが文字列として返されます。

このメソッドは、プログラムのどこでエラーが起きたかを正確に特定したいデバッグの場面で非常に役立ちます。サンプルコードの後半では、getFile()で取得したファイルパスとgetLine()で取得した行番号を利用して、エラーが発生した箇所のソースコードを直接読み込んで表示しています。このように、エラー箇所の特定と原因調査を効率的に行うために使われます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * ファイルの内容を読み込み、その行数が指定範囲内か検証します。
7 *
8 * このサンプルは、file_get_contents()で読み込んだデータに基づき、
9 * 意図的に RangeException を発生させます。
10 * そして、catchブロックで RangeException::getFile() メソッドを使い、
11 * 例外がスローされたファイル名を取得する方法を示します。
12 *
13 * @param string $filePath 検証するファイルのパス
14 * @param int $minLines 許容される最小行数
15 * @param int $maxLines 許容される最大行数
16 * @return void
17 * @throws RangeException ファイルの行数が指定された範囲外の場合
18 */
19function validateFileContentLines(string $filePath, int $minLines, int $maxLines): void
20{
21    // キーワード 'file_get_contents' を使用してファイル内容を読み込む
22    // @演算子はファイルが存在しない場合などのWarningを抑制する
23    $content = @file_get_contents($filePath);
24    if ($content === false) {
25        // 本来は別の例外（例: RuntimeException）が適切だが、今回は省略
26        echo "ファイル '{$filePath}' の読み込みに失敗しました。\n";
27        return;
28    }
29
30    // 読み込んだ内容の行数を計算する
31    // 最終行に改行コードがなくても1行と数えるために+1する
32    $lineCount = substr_count($content, "\n") + 1;
33
34    // 行数が指定された範囲外であれば、RangeExceptionをスローする
35    if ($lineCount < $minLines || $lineCount > $maxLines) {
36        throw new RangeException("行数({$lineCount})が許容範囲({$minLines}-{$maxLines})外です。");
37    }
38
39    echo "ファイル '{$filePath}' の行数({$lineCount})は正常範囲内です。\n";
40}
41
42// --- メイン処理 ---
43
44// このスクリプトが自己完結して動作するように、一時ファイルを作成・削除します
45$testFileName = 'sample_data.txt';
46// 範囲外となる1行だけのテストファイルを作成
47file_put_contents($testFileName, 'This is a single line.');
48
49try {
50    // 2〜5行を許容範囲として関数を呼び出す
51    // 1行のファイルなので、ここでRangeExceptionが発生する
52    validateFileContentLines($testFileName, 2, 5);
53} catch (RangeException $e) {
54    // スローされたRangeExceptionをキャッチする
55    echo "----------------------------------------\n";
56    echo "エラー: RangeExceptionがキャッチされました。\n";
57
58    // RangeException::getFile() を使い、例外がスローされたファイル名を取得・表示
59    // この場合、例外がthrowされたこのスクリプト自身のファイルパスが返される
60    echo "例外が発生したファイル: " . $e->getFile() . "\n";
61
62    // 参考: その他の便利なメソッド
63    echo "例外が発生した行番号: " . $e->getLine() . "\n";
64    echo "エラーメッセージ: " . $e->getMessage() . "\n";
65    echo "----------------------------------------\n";
66} finally {
67    // 処理の最後に、作成した一時ファイルを必ず削除する
68    if (file_exists($testFileName)) {
69        unlink($testFileName);
70        echo "一時ファイル '{$testFileName}' を削除しました。\n";
71    }
72}

RangeException::getFile() メソッドは、例外が発生したファイルの名前を文字列として取得するために使用します。このメソッドに引数はなく、戻り値として例外が生成されたファイルへのフルパスが返されます。

このサンプルコードは、ファイルの行数を検証し、意図的に RangeException を発生させることで getFile() の使い方を示しています。まず、validateFileContentLines 関数が file_get_contents 関数を使ってテキストファイルの内容を読み込みます。次に、その行数を数え、あらかじめ指定された最小値と最大値の範囲外であった場合に RangeException を発生させます。

メインの処理では try...catch 構文が使われています。try ブロック内で関数を実行し、RangeException が発生するとプログラムは catch ブロックに移ります。ここで、キャッチした例外オブジェクト（変数 $e）に対して $e->getFile() を呼び出すことで、例外がどのファイルで発生したかを知ることができます。このコードでは、例外を発生させた場所が実行中のスクリプト自身であるため、このPHPファイル自身のパスが表示されます。このように、エラー発生箇所の特定に役立つメソッドです。