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

Copy
1<?php
2
3/**
4 * 指定されたパスのファイル内容を取得します。
5 * ファイルが存在しない場合は RuntimeException を捕捉し、エラー情報を表示します。
6 *
7 * @param string $filePath 読み込むファイルのパス
8 * @return string|null 成功した場合はファイルの内容 (string)、失敗した場合は null
9 */
10function getFileContent(string $filePath): ?string
11{
12    try {
13        // ファイルが存在するかチェックし、存在しない場合は例外をスローする
14        if (!file_exists($filePath)) {
15            // RuntimeException は、実行時に発生したエラー（外部リソースへのアクセス失敗など）を表す例外
16            throw new RuntimeException("ファイルが見つかりません: " . $filePath);
17        }
18
19        // file_get_contents() は、ファイルの内容をすべて文字列に読み込む関数
20        $content = file_get_contents($filePath);
21
22        // file_get_contents() が失敗した場合も考慮する
23        if ($content === false) {
24            throw new RuntimeException("ファイルの読み込みに失敗しました: " . $filePath);
25        }
26
27        return $content;
28    } catch (RuntimeException $e) {
29        // try ブロック内でスローされた RuntimeException をここで捕捉する
30        echo "--- エラー情報 ---" . PHP_EOL;
31        echo "メッセージ: " . $e->getMessage() . PHP_EOL;
32
33        // getFile() メソッドは、例外が発生したファイル（このスクリプト自身）のフルパスを返す
34        echo "発生ファイル: " . $e->getFile() . PHP_EOL;
35
36        // getLine() メソッドは、例外が発生した行番号を返す
37        echo "発生行番号: " . $e->getLine() . "行目" . PHP_EOL;
38        echo "--------------------" . PHP_EOL;
39
40        return null;
41    }
42}
43
44// --- 実行例1: 失敗するケース ---
45echo "1. 存在しないファイル ('non_existent_file.txt') を読み込みます..." . PHP_EOL;
46$content1 = getFileContent('non_existent_file.txt');
47
48if ($content1 === null) {
49    echo "結果: ファイルの取得に失敗しました。" . PHP_EOL;
50}
51
52echo PHP_EOL;
53
54// --- 実行例2: 成功するケース ---
55// このスクリプトファイル自身のパスをマジック定数 __FILE__ で取得する
56echo "2. 存在するファイル (このスクリプト自身) を読み込みます..." . PHP_EOL;
57$content2 = getFileContent(__FILE__);
58
59if ($content2 !== null) {
60    echo "結果: ファイルの取得に成功しました。" . PHP_EOL;
61    // echo "ファイル内容: " . PHP_EOL . $content2; // 内容が長いため、出力はコメントアウト
62}

このPHPサンプルコードは、指定されたファイルの内容を読み込む getFileContent 関数の実装例です。ファイルの読み込みでは、ファイルが存在しないといった実行時のエラーが発生する可能性があります。このようなエラーを安全に処理するために、try-catch構文と RuntimeException という例外クラスを利用しています。

try ブロック内でファイルが見つからない、または読み込みに失敗した場合、throw new RuntimeException(...) によって意図的に例外を発生させます。この例外は catch ブロックで捕捉され、変数 $e にエラー情報が格納されます。

ここで使われている $e->getFile() は、例外オブジェクトが持つメソッドの一つです。このメソッドは引数を取らず、例外がスローされた（エラーが発生した）コードが書かれているファイルのフルパスを文字列として返します。サンプルコードでは、エラー発生箇所を特定するために、このメソッドでファイルパスを取得し表示しています。

合わせて使われている $e->getMessage() はエラーメッセージを、$e->getLine() はエラーの発生行番号を返します。これらを活用することで、問題発生時に「どのファイルの何行目で、どのようなエラーが起きたか」を正確に把握でき、デバッグ作業を効率的に進めることが可能になります。