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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * ファイルの内容を取得する関数（引数チェックのデモ）。
7 *
8 * 不正な引数が渡された際に InvalidArgumentException をスローし、
9 * catchブロックでその例外情報（特に発生ファイル）を取得する例です。
10 *
11 * @param string $filePath 読み込むファイルのパス。
12 * @throws InvalidArgumentException 引数 $filePath が空文字列の場合。
13 */
14function getFileContent(string $filePath): void
15{
16    // 引数として渡されたファイルパスが不正（例: 空文字列）な場合、
17    // InvalidArgumentExceptionをスローします。
18    if ($filePath === '') {
19        throw new InvalidArgumentException('ファイルパスを空にすることはできません。');
20    }
21
22    // 実際のファイル読み込み処理は、このサンプルでは省略します。
23    echo "ファイルパス '{$filePath}' は有効です。読み込み処理を実行します。\n";
24}
25
26try {
27    // 正常なケース
28    getFileContent('/path/to/your/file.txt');
29
30    // 不正な引数（空文字列）を渡し、意図的に例外を発生させます。
31    getFileContent('');
32} catch (InvalidArgumentException $e) {
33    // スローされた例外(InvalidArgumentException)をキャッチします。
34    echo "----------------------------------------\n";
35    echo "エラーが発生しました。\n";
36    echo "メッセージ: " . $e->getMessage() . "\n";
37
38    // getFile() メソッドを使い、例外がスローされたファイル名を取得して表示します。
39    // これにより、大規模なシステムでもエラーの原因箇所を正確に特定できます。
40    echo "発生ファイル: " . $e->getFile() . "\n";
41    echo "発生行番号: " . $e->getLine() . "\n";
42    echo "----------------------------------------\n";
43}

InvalidArgumentExceptionクラスのgetFile()メソッドは、例外（エラー）が発生したファイルの名前をフルパスの文字列として取得するために使用します。このメソッドに引数は必要ありません。

このサンプルコードでは、まずgetFileContent()という関数を定義しています。この関数は、引数として渡されたファイルパスが空文字列だった場合に、引数が不正であるという意味のInvalidArgumentExceptionを意図的に発生させます（スローします）。

try...catch構文を使い、このgetFileContent()関数を呼び出しています。tryブロック内で例外が発生すると、プログラムは即座にcatchブロックの処理に移り、発生した例外を捕捉（キャッチ）します。

catchブロックでは、捕捉した例外オブジェクト（変数$e）に対してgetFile()メソッドを実行しています。これにより、throw new InvalidArgumentException(...)が実行されたファイル名が取得され、画面に表示されます。このように、getFile()はエラーメッセージを取得するgetMessage()や、発生行を取得するgetLine()と組み合わせて使うことで、エラーの原因がどこにあるのかを正確に特定するのに役立ちます。

Copy
1<?php
2
3/**
4 * 指定されたファイルパスから内容を読み込み、文字列として返します。
5 *
6 * この関数は、file_get_contents() を使用してファイルを読み込みますが、
7 * その前に引数として渡されたファイルパスが有効かどうかを検証します。
8 *
9 * @param string $filepath 読み込むファイルのパス。
10 * @return string ファイルの内容。
11 * @throws InvalidArgumentException ファイルパスが空文字列の場合にスローされます。
12 */
13function readValidatedFile(string $filepath): string
14{
15    // 引数として渡されたファイルパスが空文字列でないか検証します。
16    // もし空であれば、これは不正な引数であるため InvalidArgumentException をスローします。
17    if ($filepath === '') {
18        throw new InvalidArgumentException('ファイルパスは空にできません。');
19    }
20
21    // file_get_contents() はファイル読み込みに失敗すると false を返します。
22    // @演算子は、ファイルが存在しない場合などのWarning（警告）出力を抑制します。
23    $content = @file_get_contents($filepath);
24
25    // 読み込みに失敗した場合の処理
26    if ($content === false) {
27        // このサンプルでは InvalidArgumentException に焦点を当てるため、
28        // 読み込み失敗時の処理はシンプルな文字列を返すだけに留めます。
29        return "ファイル '{$filepath}' の読み込みに失敗しました。";
30    }
31
32    return $content;
33}
34
35// --- メインの実行部分 ---
36
37try {
38    // わざと不正な引数（空文字列）を関数に渡して、例外を意図的に発生させます。
39    readValidatedFile('');
40} catch (InvalidArgumentException $e) {
41    // tryブロック内で InvalidArgumentException がスローされると、このcatchブロックが実行されます。
42    // $e にはスローされた例外オブジェクトが格納されています。
43
44    echo "エラーメッセージ: " . $e->getMessage() . "\n";
45
46    // InvalidArgumentException::getFile() メソッドを呼び出します。
47    // これにより、例外が 'throw' されたファイル（つまり、このスクリプトファイル自身）の
48    // フルパスを取得して表示できます。
49    echo "エラー発生ファイル: " . $e->getFile() . "\n";
50
51    // getLine() メソッドで、例外がスローされた行番号も取得できます。
52    echo "エラー発生行番号: " . $e->getLine() . "\n";
53}
54
55?>

このPHPサンプルコードは、関数に不正な引数が渡された際に発生する InvalidArgumentException と、その例外が発生したファイルパスを取得する getFile() メソッドの使い方を示しています。

readValidatedFile という関数は、ファイルパスを引数として受け取ります。この関数は、もし引数が空文字列だった場合、InvalidArgumentException という例外を throw（スロー）します。これは「関数の引数が正しくない」ことを示すための仕組みです。

メインの処理では、try...catch ブロックが使われています。try ブロック内で、わざと不正な空文字列を readValidatedFile 関数に渡して例外を発生させています。例外が発生すると、処理は catch ブロックに移り、発生した例外の情報がオブジェクト $e に格納されます。

$e->getFile() は、この例外オブジェクトが持つメソッドの一つです。このメソッドを呼び出すと、例外がスローされたファイル（このサンプルコードが保存されているファイル）のフルパスが文字列として返されます。このメソッドに引数は必要ありません。このように、エラー発生箇所のファイルを特定できるため、デバッグ作業で非常に役立ちます。