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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * UnexpectedValueException を捕捉し、
7 * getFile() で取得したファイル名を使ってそのファイルの内容を表示します。
8 *
9 * このサンプルは、自分自身のファイル内で意図的に例外を発生させ、
10 * そのファイル自身の情報を取得・表示します。
11 */
12function getFileContentOnException(): void
13{
14    try {
15        // is_int() は整数かどうかをチェックします。
16        // 文字列を渡すことで、期待しない値として UnexpectedValueException をスローします。
17        $value = 'not_an_integer';
18        if (!is_int($value)) {
19            throw new UnexpectedValueException('値が整数ではありません。');
20        }
21    } catch (UnexpectedValueException $e) {
22        // 例外を捕捉します
23        echo "例外が捕捉されました。" . PHP_EOL;
24
25        // getFile()メソッドで例外がスローされたファイルへのフルパスを取得します
26        $filePath = $e->getFile();
27        echo "例外が発生したファイル: " . $filePath . PHP_EOL . PHP_EOL;
28
29        // file_get_contents()関数を使って、取得したパスからファイルの内容を読み込みます
30        echo "--- 上記ファイルの内容 ---" . PHP_EOL;
31        $content = file_get_contents($filePath);
32        echo $content;
33    }
34}
35
36// 関数を実行します
37getFileContentOnException();

UnexpectedValueException::getFile()は、例外が発生したファイルの名前をフルパスで取得するためのメソッドです。このメソッドに引数は必要ありません。戻り値として、例外がスローされたファイルの場所を示す文字列が返されます。

サンプルコードでは、まずtryブロック内で意図的にUnexpectedValueExceptionを発生させています。具体的には、整数であることが期待される場面で文字列'not_an_integer'を使用し、is_int()関数によるチェックが偽になることで例外がスローされます。

次にcatchブロックで、発生した例外を$eという変数で捕捉します。ここで$e->getFile()を呼び出すと、このコードが書かれているPHPファイル自身のフルパスが文字列として取得できます。取得したファイルパスは変数$filePathに代入され、画面に表示されます。

最後に、そのパスをfile_get_contents()関数に渡すことで、ファイルの内容、つまりこのサンプルコード自身のソースコードを読み込んで表示しています。このようにgetFile()は、エラー発生時にどのファイルで問題が起きたかを特定するのに役立ちます。

Copy
1<?php
2
3/**
4 * ファイルを読み込み、内容が不正な場合に例外をスローするサンプルです。
5 *
6 * @param string $filepath ファイルのパス
7 * @return void
8 * @throws UnexpectedValueException ファイルの内容が期待通りでない場合
9 */
10function processFile(string $filepath): void
11{
12    // キーワード file_get_contents を使用してファイル内容を読み込む
13    // @ は、ファイルが存在しない場合などのWarningを抑制するために使用
14    $content = @file_get_contents($filepath);
15
16    // ファイルが読み込めない、または内容が期待したものでない場合に例外をスローする
17    if ($content === false || trim($content) !== 'OK') {
18        // 期待しない値が検出されたため、UnexpectedValueExceptionをスローする
19        throw new UnexpectedValueException("ファイル '$filepath' の内容が不正です。");
20    }
21
22    echo "ファイル '$filepath' の処理に成功しました。" . PHP_EOL;
23}
24
25// --- メイン処理 ---
26
27// わざと不正な内容のファイルを作成する
28$tempFile = 'test_file.txt';
29file_put_contents($tempFile, 'NG');
30
31try {
32    // 作成したファイルを処理する関数を呼び出す
33    processFile($tempFile);
34} catch (UnexpectedValueException $e) {
35    // スローされた例外をキャッチする
36    echo "エラーが発生しました。" . PHP_EOL;
37    echo "メッセージ: " . $e->getMessage() . PHP_EOL;
38
39    // UnexpectedValueException::getFile() を使って、
40    // 例外がスローされたスクリプトファイル名を取得し表示する
41    echo "ファイル: " . $e->getFile() . PHP_EOL;
42    
43    // 参考: getLine() で行番号も取得できる
44    echo "行番号: " . $e->getLine() . PHP_EOL;
45} finally {
46    // 後処理として、作成した一時ファイルを削除する
47    if (file_exists($tempFile)) {
48        unlink($tempFile);
49    }
50}

このPHPサンプルコードは、プログラムの実行中に予期しない値が見つかった際に使用されるUnexpectedValueExceptionという例外の扱い方を示しています。特に、この例外オブジェクトが持つgetFile()メソッドの具体的な使用例です。

コード前半のprocessFile関数は、file_get_contents関数で指定されたファイルの内容を読み込みます。その内容が期待する文字列 'OK' でない場合に、UnexpectedValueExceptionを発生させます（スローします）。

メイン処理では、try...catchブロック構文を用いて、このprocessFile関数を実行し、発生する可能性のある例外を捕捉（キャッチ）しています。例外がキャッチされると、catchブロック内の処理が実行されます。

$e->getFile()は、例外がスローされたPHPスクリプトのファイルパスを取得するためのメソッドです。このメソッドに引数は必要なく、戻り値としてファイルパスを表す文字列（string）が返されます。これにより、プログラムのどのファイルで問題が発生したのかを正確に特定できます。サンプルでは、getMessage()でエラー内容、getLine()で行番号も併せて表示しており、エラーの原因調査（デバッグ）に役立つ情報がまとめて取得できることを示しています。