【PHP8.x】getFileメソッドの使い方
作成日: 更新日:
getFileメソッドは、エラーが発生したファイルの名前をフルパスで取得するために実行するメソッドです。PHPのプログラム実行中に、文法エラーや致命的な問題が発生すると Error
オブジェクトが生成され、スローされます。このメソッドは、主に try...catch
構文を用いて Error
オブジェクトを捕捉した際に、そのエラーがどのファイルで起きたのかを正確に特定するために利用されます。戻り値は、エラー発生元のファイルへの絶対パスを含む文字列です。これにより、プロジェクト内のどのファイルのコードに問題があるのかを迅速に突き止めることが可能になります。デバッグやエラーログの記録において、エラーが発生した行番号を取得する getLine
メソッドと合わせて使用されることが多く、問題解決に不可欠な情報を提供します。なお、このメソッドは Throwable
インターフェースで定義されているため、Exception
クラスのインスタンスに対しても同様に呼び出すことができます。
基本的な使い方
構文(syntax)
1<?php 2try { 3 // 存在しない関数を呼び出してErrorを発生させる 4 non_existent_function(); 5} catch (Error $e) { 6 // エラーが発生したファイル名を取得する 7 $fileName = $e->getFile(); 8 echo $fileName; 9}
引数(parameters)
引数なし
引数はありません
戻り値(return)
string
Error クラスの getFile()
メソッドは、エラーが発生したファイルの名前を文字列で返します。