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

Copy
1<?php
2
3// 存在しないファイル名を指定し、file_get_contents() が失敗する状況を作り出します。
4$nonExistentFile = 'non_existent_example.txt';
5
6// PHPの警告 (Warning) を ErrorException 例外に変換するエラーハンドラを設定します。
7// これにより、ファイルが見つからないなどの問題で file_get_contents() が警告を出す代わりに、
8// try-catch ブロックで捕捉可能な ErrorException がスローされるようになります。
9set_error_handler(function (int $errno, string $errstr, string $errfile, int $errline) {
10    throw new ErrorException($errstr, 0, $errno, $errfile, $errline);
11});
12
13try {
14    echo "Attempting to read file: " . $nonExistentFile . "\n";
15    // 存在しないファイルを読み込もうとすると、エラーハンドラによりErrorExceptionがスローされます。
16    $content = file_get_contents($nonExistentFile);
17    echo "File content: " . $content . "\n"; // この行は実行されません
18} catch (ErrorException $e) {
19    // ErrorException をキャッチし、その情報を表示します。
20    echo "Caught an ErrorException!\n";
21    echo "Error message: " . $e->getMessage() . "\n";
22
23    // Exception::file プロパティは、例外がスローされたPHPスクリプトのファイルパスを返します。
24    // 通常、このプロパティは getFile() メソッドでアクセスします。
25    // この場合、file_get_contents() の呼び出しを含む現在のスクリプトのパスが返されます。
26    echo "File where exception occurred: " . $e->getFile() . "\n";
27    echo "Line where exception occurred: " . $e->getLine() . "\n";
28} finally {
29    // 実行完了後、設定したエラーハンドラを元のPHPのデフォルト状態に戻します。
30    // これは良い習慣です。
31    restore_error_handler();
32}
33

PHPのExceptionクラスには、fileというプロパティがあり、例外が発生したPHPスクリプトのファイルパスを文字列として返します。このプロパティに直接アクセスする代わりに、通常はgetFile()メソッドを通じて取得します。引数はなく、常に文字列を戻り値とします。

このサンプルコードでは、まず存在しないファイルをfile_get_contents()関数で読み込もうとすることで、意図的にエラーを発生させています。PHPの通常の警告（Warning）をtry-catchブロックで捕捉可能なErrorExceptionに変換するため、一時的にエラーハンドラを設定しています。

tryブロック内でfile_get_contents()の呼び出しが失敗すると、設定したエラーハンドラによりErrorExceptionがスローされます。この例外はcatchブロックで捕捉され、例外オブジェクト（$e）から様々な情報を取り出します。$e->getFile()を呼び出すことで、例外がスローされたPHPスクリプトの正確なファイルパスが取得できます。この場合、file_get_contents()の呼び出しを含んでいる、現在実行中のスクリプトのファイルパスが表示されます。

このように、Exception::fileプロパティは、エラーがどのファイルで発生したのかを迅速に特定し、問題解決に役立てるための重要な情報を提供します。最後に、設定したエラーハンドラはfinallyブロックで元に戻し、プログラムの終了前にクリーンアップを行っています。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定されたファイルパスにコンテンツを書き込もうとします。
7 * 書き込みに失敗した場合はExceptionをスローします。
8 *
9 * @param string $filePath 書き込み先のファイルパス
10 * @param string $content  書き込む内容
11 * @throws \Exception ファイル書き込みに失敗した場合
12 */
13function try_write_content_to_file(string $filePath, string $content): void
14{
15    // file_put_contents はファイルにコンテンツを書き込みます。
16    // 成功した場合は書き込まれたバイト数を返し、失敗した場合は false を返します。
17    $bytesWritten = file_put_contents($filePath, $content);
18
19    if ($bytesWritten === false) {
20        // file_put_contents が失敗した場合、エラーメッセージを添えてExceptionをスローします。
21        // ここでスローされる例外のファイル情報は、この関数が定義されているファイル（このスクリプト自身）を指します。
22        throw new \Exception("ファイルの書き込みに失敗しました: '{$filePath}'");
23    }
24
25    echo "成功: ファイル '{$filePath}' に " . $bytesWritten . " バイト書き込みました。\n";
26}
27
28// --- メイン処理 ---
29
30// 存在するディレクトリ内のファイルパス（書き込みが成功するケース）
31$successfulFilePath = 'example_success.txt';
32// 存在しないディレクトリ内のファイルパス（書き込みが失敗するケースを意図的に作成）
33// 通常、このディレクトリは事前に作成されている必要がありますが、ここでは存在しないものとします。
34// このパスへの書き込みは失敗し、例外が発生します。
35$failingDirectory = 'non_existent_directory_for_test';
36$failingFilePath = $failingDirectory . '/example_fail.txt';
37
38try {
39    // 1. ファイル書き込みの成功例
40    try_write_content_to_file($successfulFilePath, "これは成功する書き込みです。\n");
41
42    // 2. ファイル書き込みの失敗例
43    // この呼び出しが原因で例外が発生し、try-catchブロックで捕捉されます。
44    try_write_content_to_file($failingFilePath, "これは失敗する書き込みです。\n");
45
46} catch (\Exception $e) {
47    // 例外が捕捉された場合、その詳細を表示します。
48    echo "\n--- エラーが発生しました ---\n";
49    echo "エラーメッセージ: " . $e->getMessage() . "\n";
50
51    // Exception::file プロパティは、例外がスローされたPHPスクリプトのファイルパスを保持しています。
52    // このプロパティにアクセスするには、Exceptionクラスの `getFile()` メソッドを使用します。
53    // この例では、`try_write_content_to_file` 関数内で例外がスローされたため、
54    // `getFile()` はこのスクリプト自体のファイルパス（エラーをスローした場所のファイル）を返します。
55    echo "エラーが発生したファイル: " . $e->getFile() . "\n";
56    echo "エラーが発生した行: " . $e->getLine() . "\n";
57} finally {
58    // 後処理: テストで作成されたファイルを削除します。
59    if (file_exists($successfulFilePath)) {
60        unlink($successfulFilePath);
61        echo "\n後処理: '{$successfulFilePath}' を削除しました。\n";
62    }
63    // 失敗したファイルは作成されていないため、削除の必要はありません。
64}
65

PHPのExceptionクラスは、プログラム実行中に予期せぬ問題が発生した際に、そのエラー情報を格納するための標準的なクラスです。Exception::fileは、この例外が発生したPHPスクリプトのファイルパスを指し示すプロパティですが、通常はgetFile()メソッドを通じてその値を取得します。

このgetFile()メソッドは引数を取らず、例外がスローされた場所のPHPスクリプトの完全なファイルパスを文字列（string）として返します。システムエンジニアにとって、これはエラー発生箇所を特定するための非常に重要な情報となります。

提供されたサンプルコードでは、try_write_content_to_file関数がfile_put_contentsによるファイル書き込みに失敗した場合にExceptionをスローしています。この例外がtry-catchブロックで捕捉された際、$e->getFile()を呼び出すことで、例外がスローされたファイル（このスクリプト自身）のパスを確認できます。これにより、エラーがどのファイルで発生したかを迅速に把握し、問題解決に役立てることが可能です。getFile()の戻り値は常に文字列型で、エラーの原因調査を効率的に行うための情報を提供します。