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

fileプロパティは、例外がスローされたファイル名を保持するプロパティです。このプロパティは、PHPのすべての例外クラスの基底となるExceptionクラスで定義されており、DomainExceptionクラスはこれを継承しています。プログラムの実行中にDomainExceptionが発生すると、PHPエンジンは例外が生成されたソースコードが含まれるファイルのフルパスをこのプロパティに自動的に設定します。開発者はこの情報を利用することで、エラーが発生した正確な場所を迅速に特定できます。これは、特に規模の大きなアプリケーションや複雑なコードベースで問題の原因を調査する際のデバッグ作業において、非常に重要な役割を果たします。なお、このfileプロパティはprotectedスコープで宣言されているため、オブジェクトの外部から直接アクセスすることは推奨されません。プロパティの値を取得する際には、代わりに公開されているgetFile()メソッドを使用するのが一般的です。

Copy
1<?php
2
3try {
4    // DomainExceptionを意図的にスローします。
5    throw new DomainException("ドメインエラー");
6} catch (DomainException $e) {
7    // fileプロパティの値は、getFile()メソッドで取得します。
8    $fileName = $e->getFile();
9    // 例外が発生したファイル名を出力します。
10    echo $fileName;
11}

引数なし

引数はありません

string

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