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

fileプロパティは、例外がスローされたファイルの名前を保持するプロパティです。このプロパティは、PHPの基本的な例外クラスであるExceptionクラスで定義されており、LogicExceptionはそれを継承しているため利用できます。プログラムの実行中にLogicExceptionまたはそのサブクラスの例外が発生すると、PHPエンジンはエラーが発生したファイルへの絶対パスを自動的にこのプロパティに文字列として格納します。例えば、/path/to/your/project/somefile.phpといった値が設定されます。この情報は、主にデバッグやエラーログの記録のために非常に重要です。try...catchブロックで例外を捕捉した際に、このプロパティの値をgetFile()メソッド経由で取得することで、どのファイルで問題が起きたのかを正確に特定できます。エラーメッセージや発生行番号といった他の情報と組み合わせることで、エラーの原因究明を効率的に進めることが可能になります。なお、このプロパティはprotected属性であるため、クラスの外部から直接アクセスすることはできず、値の取得には必ずgetFile()メソッドを使用する必要があります。

Copy
1<?php
2
3try {
4    throw new LogicException();
5} catch (LogicException $e) {
6    // 例外がスローされたファイル名を取得します
7    echo $e->getFile();
8}
9
10?>

引数なし

引数はありません

string

このプロパティは、例外が発生したソースファイルのパスを文字列で返します。