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

Copy
1<?php
2
3/**
4 * 指定されたファイルの存在を確認し、存在しない場合に例外をスローします。
5 *
6 * @param string $filepath チェック対象のファイルパス
7 * @throws RuntimeException ファイルが存在しない場合にスローされます
8 */
9function processFile(string $filepath): void
10{
11    // file_exists() を使用して、ファイルの存在を確認します。
12    if (!file_exists($filepath)) {
13        // ファイルが存在しない場合、RuntimeException をスローします。
14        // この例外オブジェクトには、エラーが発生したファイルや行番号の情報が自動的に含まれます。
15        throw new RuntimeException("ファイルが見つかりませんでした。");
16    }
17
18    // 本来はここでファイル処理を行う
19    echo "ファイルは正常に存在します: " . $filepath . PHP_EOL;
20}
21
22// 意図的に存在しないファイルパスを指定します。
23$nonExistentFile = 'path/to/dummy_file.txt';
24
25try {
26    // ファイル処理関数を実行します。例外が発生する可能性があります。
27    processFile($nonExistentFile);
28} catch (RuntimeException $e) {
29    // processFile関数内でスローされたRuntimeExceptionをキャッチします。
30    echo "エラーが発生しました。" . PHP_EOL;
31    echo "--------------------" . PHP_EOL;
32    echo "メッセージ: " . $e->getMessage() . PHP_EOL;
33
34    // getFile() メソッドを使用して、例外がスローされたファイル名を取得します。
35    // これは、リファレンスにある `RuntimeException` の `file` プロパティの値に相当します。
36    echo "発生ファイル: " . $e->getFile() . PHP_EOL;
37    echo "発生行: " . $e->getLine() . PHP_EOL;
38}

このPHPサンプルコードは、file_exists()関数でファイルの存在を確認し、ファイルが見つからない場合にRuntimeExceptionという例外を発生させる例です。

RuntimeExceptionは、プログラムの実行中に発生したエラーを示すためのクラスです。このクラスが持つfileプロパティは、例外がスローされた（throwされた）ソースコードのファイル名を文字列として保持します。このプロパティの値を取得するために、getFile()メソッドが用意されています。このメソッドは引数を取らず、例外が発生したファイル名を戻り値として返します。

コード内のtry...catchブロックでは、processFile関数からスローされたRuntimeExceptionを捕捉しています。そしてcatchブロック内で$e->getFile()を呼び出すことにより、例外がどのファイルで発生したかを取得し、画面に表示しています。このようにgetFile()メソッドを使うことで、エラーの発生箇所を正確に特定でき、デバッグ作業を効率的に進めることが可能になります。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定されたファイルの内容を読み込みます。
7 * 読み込みに失敗した場合、RuntimeExceptionをスローします。
8 *
9 * @param string $filePath 読み込むファイルのパス
10 * @return string ファイルの内容
11 * @throws RuntimeException ファイルが読み込めなかった場合
12 */
13function getContentOrThrow(string $filePath): string
14{
15    // file_get_contents() は失敗時に警告を出し false を返します。
16    // @演算子で警告を抑制し、戻り値で成否を判断します。
17    $content = @file_get_contents($filePath);
18
19    if ($content === false) {
20        // 読み込みに失敗した場合、RuntimeExceptionを生成してスローします。
21        // これにより、エラー処理を呼び出し元に委ねることができます。
22        throw new RuntimeException("ファイル '{$filePath}' の読み込みに失敗しました。");
23    }
24
25    return $content;
26}
27
28// 意図的に存在しないファイルパスを指定します。
29$nonExistentFilePath = 'non_existent_file.txt';
30
31try {
32    // 関数の呼び出しをtryブロックで囲み、例外が発生する可能性に備えます。
33    echo "ファイルの読み込みを試みます: {$nonExistentFilePath}" . PHP_EOL;
34    $fileContent = getContentOrThrow($nonExistentFilePath);
35    echo "読み込み成功:" . PHP_EOL;
36    echo $fileContent;
37} catch (RuntimeException $e) {
38    // throwされたRuntimeExceptionをcatchブロックで捕捉します。
39    echo "エラーを捕捉しました。" . PHP_EOL;
40    echo "--------------------" . PHP_EOL;
41    echo "メッセージ: " . $e->getMessage() . PHP_EOL;
42
43    // $e->getFile() は例外がスローされたファイル名（このファイル自身）を返します。
44    // これは RuntimeException クラスが持つ 'file' プロパティの値に対応します。
45    echo "発生ファイル: " . $e->getFile() . PHP_EOL;
46    echo "発生行: " . $e->getLine() . PHP_EOL;
47    echo "--------------------" . PHP_EOL;
48}

このPHPサンプルコードは、ファイルの読み込み処理でエラーが発生した際の例外処理の方法を示しています。

getContentOrThrow関数は、キーワードであるfile_get_contents関数を使い、指定されたファイルの内容を文字列として読み込みます。ファイルが存在しないなどの理由で読み込みに失敗した場合、この関数はRuntimeExceptionという種類の例外を発生させます。

メインの処理では、try-catch構文を用いて例外を捕捉する準備をしています。tryブロックの中で、意図的に存在しないファイル名を指定してgetContentOrThrow関数を呼び出します。これにより関数内でRuntimeExceptionがスローされると、プログラムの実行は直ちにcatchブロックに移ります。

catchブロックでは、スローされたRuntimeExceptionオブジェクトを$eという変数で受け取ります。このオブジェクトが持つgetFile()メソッドを呼び出すと、例外がスローされたファイルの名前を文字列として取得できます。これは、リファレンス情報にあるRuntimeExceptionクラスのfileプロパティの値に対応します。このように、例外オブジェクトのメソッドを利用することで、エラーメッセージや発生ファイル、行番号といった詳細な情報を取得し、問題の原因究明に役立てることができます。