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

『fileプロパティは、例外が生成されたソースコードのファイル名を保持するプロパティです。このプロパティはInvalidArgumentExceptionクラスに属していますが、実際にはその基底クラスであるExceptionクラスで定義されているため、PHPにおける多くの例外クラスで共通して利用できます。プログラムの実行中、メソッドや関数に予期しない型の引数が渡された場合などにInvalidArgumentExceptionがスローされると、このfileプロパティには、その例外が発生した時点のPHPファイルの絶対パスが自動的に格納されます。

この情報は、主にデバッグの目的で使用されます。try-catchブロックで例外オブジェクトを捕捉した際に、どのファイルのどの部分で問題が起きたのかを特定するための重要な手がかりとなります。ただし、このプロパティはprotectedとして宣言されているため、インスタンスから直接参照するのではなく、公開されているgetFile()メソッドを呼び出して値を取得することが推奨されています。ログファイルにこのファイル名を記録することで、エラーの原因追跡を効率的に行うことができます。』

Copy
1<?php
2
3try {
4    // この例では、手動で例外をスローします
5    throw new InvalidArgumentException("引数が無効です。");
6} catch (InvalidArgumentException $e) {
7    // $fileプロパティはprotectedですが、getFile()メソッドで値を取得できます
8    echo $e->getFile();
9}

引数なし

引数はありません

string

InvalidArgumentException クラスの file プロパティは、例外が発生した際に、関連するファイルの名前を文字列で返します。