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

『fileプロパティは、RangeException例外が発生したソースファイルの名前を保持するプロパティです』

このプロパティは、PHPの基本的な例外クラスであるExceptionクラスから継承されたもので、例外がスローされたPHPスクリプトのファイル名が、フルパス形式の文字列として格納されます。RangeExceptionは、プログラムのロジック上、値が期待される有効な範囲を超えてしまった場合に発生するエラーです。例えば、関数の引数に想定されていない範囲の値が渡された場合などがこれにあたります。

プログラム開発中にエラーが発生した際、その原因を特定するためには「どのファイルの」「何行目で」問題が起きたかという情報が不可欠です。このfileプロパティは、まさに「どのファイルで」という情報を提供し、エラー解決の重要な手がかりとなります。通常、このプロパティの値は直接参照するのではなく、公開されているgetFile()メソッドを呼び出すことで安全に取得します。エラーログに例外情報を記録したり、開発中にエラーの詳細を表示したりする際に、このfileプロパティが持つファイルパスは、lineプロパティ（行番号）やmessageプロパティ（エラーメッセージ）と並んで、デバッグに欠かせない情報となります。

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

引数なし

引数はありません

string

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