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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定されたファイルパスの妥当性を検証するクラス
7 */
8class FileValidator
9{
10    /**
11     * ファイルの存在を確認し、存在しない場合は例外をスローします。
12     *
13     * @param string $path チェックするファイルのパス
14     * @return void
15     * @throws RangeException ファイルが存在しない場合にスローされます
16     */
17    public function validateFileExists(string $path): void
18    {
19        // file_exists() を使用して、指定されたパスにファイルが存在するかどうかを確認します。
20        // ディレクトリの場合も true を返すため、is_file() と併用するとより厳密になりますが、
21        // このサンプルでは file_exists() の基本的な使い方を示します。
22        if (!file_exists($path)) {
23            // ファイルが存在しない（期待される状態の範囲外である）ため、RangeException をスローします。
24            throw new RangeException("指定されたファイルが見つかりません: {$path}");
25        }
26
27        echo "ファイル '{$path}' は存在します。" . PHP_EOL;
28    }
29}
30
31// --- ここから実行コード ---
32
33$validator = new FileValidator();
34
35// 存在しないファイルパスを指定します
36$nonExistentFilePath = 'path/to/non_existent_file.txt';
37
38try {
39    // 存在しないファイルに対して検証メソッドを実行します
40    $validator->validateFileExists($nonExistentFilePath);
41} catch (RangeException $e) {
42    // スローされた RangeException をキャッチします
43    echo "エラー: " . $e->getMessage() . PHP_EOL;
44
45    // $e->getFile() は、例外がスローされた「スクリプトファイル」のフルパスを取得します。
46    // ここでは、このPHPファイル自体のパスが表示されます。
47    // これは RangeException クラスが持つ file プロパティ（実際には getFile() メソッド）の機能です。
48    echo "例外が発生したファイル: " . $e->getFile() . PHP_EOL;
49    echo "例外が発生した行番号: " . $e->getLine() . PHP_EOL;
50}

このPHPサンプルコードは、指定されたパスにファイルが存在するかどうかを検証し、存在しない場合に RangeException という種類の例外（エラー）を発生させる例です。

FileValidatorクラスの validateFileExists メソッドは、PHPの組み込み関数 file_exists() を使ってファイルの存在を確認します。file_exists() は、引数で受け取ったパスにファイルやディレクトリが存在すれば true を、存在しなければ false を返します。このサンプルでは、ファイルが存在しないという、期待される状態の範囲から外れた場合に RangeException を意図的に発生させています。

try...catch ブロックは、発生した RangeException を捕捉するために使われます。catchブロック内で使用されている $e->getFile() メソッドは、捕捉した例外オブジェクトが持つ機能の一つです。このメソッドは引数を取らず、例外がスローされたPHPスクリプトファイル自体のフルパスを文字列として返します。そのため、サンプルコードの出力では「例外が発生したファイル」として、このコードが書かれているファイル自身のパスが表示されます。これは、どのファイルのどの場所でエラーが起きたのかを特定する際に役立ちます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定されたファイルの内容を安全に読み込むサンプルです。
7 *
8 * file_get_contents() を使用してファイルを読み込みます。
9 * 読み込みに失敗した場合、意図的に RangeException をスローし、
10 * catch ブロックで例外情報を捕捉して表示します。
11 */
12function readFileSafely(string $filePath): void
13{
14    try {
15        // file_get_contents() はファイルが存在しない場合などに false を返し、Warning を発生させます。
16        // @ 演算子で Warning の出力を抑制し、戻り値のチェックでエラーをハンドリングします。
17        $content = @file_get_contents($filePath);
18
19        // 読み込みに失敗した場合 (戻り値が false だった場合)
20        if ($content === false) {
21            // RangeException をスローします。
22            // 本来は値が有効範囲外であることを示す例外ですが、
23            // ここでは「有効なファイル内容が取得できなかった」という文脈で使用します。
24            throw new RangeException("ファイル '{$filePath}' が見つからないか、読み込めません。");
25        }
26
27        // 読み込みに成功した場合、内容を出力します。
28        echo "ファイルの内容:\n";
29        echo $content;
30    } catch (RangeException $e) {
31        // スローされた RangeException を捕捉します。
32        echo "エラーが発生しました。\n";
33        echo "メッセージ: " . $e->getMessage() . "\n";
34
35        // $e->getFile() は例外がスローされた「PHPスクリプトファイル」のパスを返します。
36        // これはリファレンスの RangeException->file プロパティに相当する情報を取得するメソッドです。
37        echo "発生ファイル: " . $e->getFile() . "\n";
38        echo "発生行: " . $e->getLine() . "\n";
39    }
40}
41
42// 存在しないファイルパスを指定して関数を実行します。
43readFileSafely('non_existent_file.txt');
44
45?>

このPHPサンプルコードは、ファイルの読み込み処理でエラーが発生した際に、そのエラー情報を取得する方法を示しています。readFileSafely関数は、file_get_contents()を使って指定されたファイルの内容を読み込もうとします。

このコードの重要な点は、try...catchブロックです。tryブロック内で、file_get_contents()がファイルの読み込みに失敗すると、throw new RangeException(...)という記述によって意図的にRangeExceptionという種類の例外を発生させます。

発生した例外はcatch (RangeException $e)ブロックで捕捉されます。このとき、変数$eには例外に関する情報が格納されたオブジェクトが代入されます。RangeExceptionクラスが持つfileプロパティは、例外がどのPHPスクリプトファイルで発生したかという情報（ファイルパス）を保持しています。このプロパティの値は、引数なしで呼び出せる$e->getFile()メソッドで取得でき、戻り値としてファイルパスを文字列で返します。

サンプルコードでは、存在しないファイルを指定しているため、必ず例外が発生します。その結果、catchブロック内でエラーメッセージと共に、$e->getFile()によって例外がスローされたPHPファイル自身のパスが表示されます。このように、fileプロパティはエラーの原因箇所を特定するデバッグ作業で役立ちます。