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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 設定ファイルを読み込むクラスの例。
7 * file_exists() を使用して、ファイル操作の前に存在確認を行います。
8 */
9class ConfigLoader
10{
11    /**
12     * 指定されたパスのファイルを読み込みます。
13     *
14     * ファイルが存在しない場合は、引数が無効であるとして
15     * InvalidArgumentException をスローします。
16     * 例外の file プロパティ（getFile() メソッドで取得）には、
17     * この例外がスローされたスクリプトのファイルパスが格納されます。
18     *
19     * @param string $filePath 読み込むファイルのパス
20     * @return string ファイルが存在する場合に成功メッセージを返す
21     * @throws InvalidArgumentException ファイルが存在しない場合
22     */
23    public function load(string $filePath): string
24    {
25        // file_exists() を使って、指定されたパスにファイルが存在するかを確認します。
26        if (!file_exists($filePath)) {
27            // ファイルが存在しない場合、処理を続行できないため例外をスローします。
28            throw new InvalidArgumentException("設定ファイルが見つかりません: {$filePath}");
29        }
30
31        // ファイルが存在する場合の処理（この例では成功メッセージを返すだけです）
32        // 実際には file_get_contents() などでファイル内容を読み込みます。
33        return "ファイル '{$filePath}' の読み込みに成功しました。";
34    }
35}
36
37// --- 以下、実行コード ---
38
39$loader = new ConfigLoader();
40
41// 1. 成功するケース: 存在するファイル（このスクリプト自身）を指定
42// __FILE__ は現在実行中のPHPファイル自身のフルパスを返すマジック定数です。
43$existingFilePath = __FILE__;
44try {
45    $message = $loader->load($existingFilePath);
46    echo $message . PHP_EOL;
47} catch (InvalidArgumentException $e) {
48    echo "エラー: " . $e->getMessage() . PHP_EOL;
49}
50
51echo "--------------------" . PHP_EOL;
52
53// 2. 失敗するケース: 存在しないファイルを指定
54$nonExistentFilePath = 'non_existent_file.ini';
55try {
56    $loader->load($nonExistentFilePath);
57} catch (InvalidArgumentException $e) {
58    // ここで例外が捕捉されます。
59    echo "エラー: " . $e->getMessage() . PHP_EOL;
60    // $e->getFile() は例外が発生したファイル（このファイル）のパスを返します。
61    echo "例外が発生したファイル: " . $e->getFile() . PHP_EOL;
62    echo "例外が発生した行番号: " . $e->getLine() . PHP_EOL;
63}
64
65?>

このPHPサンプルコードは、指定されたファイルが存在するかを確認し、存在しない場合に InvalidArgumentException という例外を発生させるクラスの例です。

ConfigLoaderクラスのloadメソッドは、まずfile_exists()関数を使い、引数で受け取ったファイルパスが実際に存在するかを検証します。もしファイルが存在しない場合、メソッドの引数が無効であると判断し、InvalidArgumentExceptionを発生させ処理を中断します。

プログラムがこの例外をcatchブロックで捕捉した際、その例外オブジェクトが持つfileプロパティにgetFile()メソッドでアクセスできます。このメソッドは引数を取らず、例外が 発生した PHPスクリプトのファイルパスを文字列として返します。サンプルコードの失敗ケースで$e->getFile()が返すのは、存在しなかったファイル名ではなく、throw文が実行されたこのコード自身のファイルパスです。この情報は、プログラムのどの場所で問題が起きたのかを特定するデバッグ作業で役立ちます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定されたファイルパスからコンテンツを安全に読み込みます。
7 *
8 * この関数は file_get_contents() のラッパーとして機能し、
9 * 引数が無効な場合に InvalidArgumentException をスローします。
10 *
11 * @param string $path 読み込むファイルのパス
12 * @return string ファイルのコンテンツ
13 * @throws InvalidArgumentException パスが空、またはファイルが存在しない場合にスローされます。
14 */
15function readContentFromFile(string $path): string
16{
17    // 引数 $path が空文字列かどうかを検証します。
18    if (empty($path)) {
19        // 引数が無効なため、例外をスローします。
20        throw new InvalidArgumentException('ファイルパスが指定されていません。');
21    }
22
23    // file_exists() でファイルの存在を確認します。
24    if (!file_exists($path)) {
25        // ファイルが存在しない場合も、引数が無効であるとみなし、例外をスローします。
26        throw new InvalidArgumentException("指定されたファイルが見つかりません: {$path}");
27    }
28
29    // file_get_contents() は失敗すると false を返すため、エラーハンドリングを行います。
30    // @ 演算子は、この関数が失敗した場合に発生するPHPの警告(E_WARNING)を抑制します。
31    $content = @file_get_contents($path);
32    if ($content === false) {
33        // 読み込みに失敗した場合、実行時エラーとして例外をスローします。
34        throw new RuntimeException("ファイルの読み込みに失敗しました: {$path}");
35    }
36
37    return $content;
38}
39
40// --- 以下、サンプルコードの実行部分 ---
41
42// テスト用のダミーファイルを作成します。
43$dummyFile = 'sample.txt';
44file_put_contents($dummyFile, 'これはPHPのテストファイルです。');
45
46try {
47    // 1. 成功するケース：有効なファイルパスを渡します。
48    echo "--- 成功ケース ---" . PHP_EOL;
49    $content = readContentFromFile($dummyFile);
50    echo "読み込んだ内容: " . $content . PHP_EOL;
51    echo PHP_EOL;
52
53    // 2. 失敗するケース：わざと空のファイルパスを渡し、例外を発生させます。
54    echo "--- 失敗ケース ---" . PHP_EOL;
55    readContentFromFile('');
56
57} catch (InvalidArgumentException $e) {
58    // InvalidArgumentException がスローされた場合、このブロックで捕捉します。
59    echo "エラータイプ: " . get_class($e) . PHP_EOL;
60    echo "エラーメッセージ: " . $e->getMessage() . PHP_EOL;
61
62    // InvalidArgumentExceptionオブジェクトの`getFile()`メソッドは、
63    // 例外がスローされたファイル（このスクリプトファイル自身）のパスを返します。
64    // これは、リファレンス情報の`file`プロパティに相当します。
65    echo "エラーが発生したファイル: " . $e->getFile() . PHP_EOL;
66    echo "エラーが発生した行番号: " . $e->getLine() . PHP_EOL;
67
68} catch (RuntimeException $e) {
69    // その他の実行時エラーを捕捉します。
70    echo "予期せぬエラーが発生しました: " . $e->getMessage() . PHP_EOL;
71
72} finally {
73    // try-catchブロックの処理が完了した後、必ず実行されます。
74    // テスト用に作成したダミーファイルを削除します。
75    if (file_exists($dummyFile)) {
76        unlink($dummyFile);
77    }
78}

このPHPサンプルコードは、指定されたファイルの内容を安全に読み込むreadContentFromFile関数を定義しています。この関数は、引数として受け取ったファイルパスが無効な場合、例えば空の文字列であったり、存在しないファイルであったりした場合にInvalidArgumentExceptionという種類の例外を発生させます。例外とは、プログラムの実行中に発生したエラーを開発者が検知し、対処するための仕組みです。

InvalidArgumentExceptionオブジェクトは、発生したエラーに関する詳細情報を持っています。その一つが、リファレンス情報にあるfileプロパティです。このプロパティの値は、$e->getFile()というメソッドを呼び出すことで取得できます。getFile()メソッドは引数を取らず、例外が発生したソースコードが記述されているファイルのフルパスを文字列として返します。

サンプルコードの後半では、try...catchブロックを使って、意図的に発生させた例外を捕捉しています。readContentFromFile('')が実行されるとInvalidArgumentExceptionがスローされ、catchブロック内で$e->getFile()が呼び出されます。これにより、エラーが「どのファイルで」起きたのかが画面に出力され、開発者は問題の箇所を迅速に特定できます。