【PHP8.x】Exception::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()の戻り値は常に文字列型で、エラーの原因調査を効率的に行うための情報を提供します。

Copy
1<?php
2
3/**
4 * 指定されたファイルが存在するかチェックし、存在しない場合は例外をスローします。
5 *
6 * この関数は、システムエンジニアを目指す初心者が、
7 * ファイル操作におけるエラーハンドリングの基本と、
8 * PHPのExceptionクラスの`file`プロパティ、
9 * そして`file_exists`関数の使い方を理解するのに役立ちます。
10 *
11 * @param string $filePath 確認するファイルパス
12 * @return void
13 * @throws Exception ファイルが存在しない場合
14 */
15function checkFileExistenceAndThrowIfMissing(string $filePath): void
16{
17    // file_exists() 関数は、指定されたファイルまたはディレクトリが存在するかどうかを調べます。
18    if (!file_exists($filePath)) {
19        // ファイルが存在しない場合、Exceptionをスローします。
20        // この例外をスローしたコード（この関数の定義箇所）のファイルパスが、
21        // 後に取得するException::fileプロパティに格納されます。
22        throw new Exception("エラー: ファイルが見つかりません。パス: " . $filePath);
23    }
24    echo "ファイル '{$filePath}' は存在します。\n";
25}
26
27// ----------------------------------------------------
28// サンプルコードの実行
29// ----------------------------------------------------
30
31// 1. 存在するファイルのパス（このスクリプト自身のパス）
32$existingFile = __FILE__;
33// 2. 存在しないファイルのパス
34$nonExistingFile = __DIR__ . '/non_existent_file.txt';
35
36echo "--- 存在するファイルパスの確認 ---\n";
37try {
38    checkFileExistenceAndThrowIfMissing($existingFile);
39} catch (Exception $e) {
40    // このブロックには到達しないはず
41    echo "予期せぬエラー: " . $e->getMessage() . "\n";
42}
43
44echo "\n--- 存在しないファイルパスの確認 ---\n";
45try {
46    checkFileExistenceAndThrowIfMissing($nonExistingFile);
47} catch (Exception $e) {
48    echo "捕捉されたエラー: " . $e->getMessage() . "\n";
49
50    // Exception::getFile() メソッドは、例外がスローされたPHPスクリプトのファイルパスを返します。
51    // これは、`Exception::file`プロパティにアクセスする推奨される方法です。
52    // この場合、`checkFileExistenceAndThrowIfMissing`関数が定義されているファイル（このスクリプト）のパスになります。
53    echo "例外が発生したソースファイル: " . $e->getFile() . "\n";
54
55    // エラーメッセージから、実際に存在しなかったファイルのパスを抽出する例。
56    // （実際のアプリケーションでは、より堅牢な方法でパスを抽出します。）
57    $messageParts = explode('パス: ', $e->getMessage());
58    $pathFromMessage = end($messageParts);
59
60    // 抽出したパスが本当に存在しないか、file_exists() を使って再確認します。
61    // これは、`file_exists`が引数に指定されたファイルパスの存在を直接確認するものであることを示します。
62    if (!empty($pathFromMessage) && !file_exists($pathFromMessage)) {
63        echo "エラーメッセージ内のファイル ('" . $pathFromMessage . "') は確かに存在しません。\n";
64    }
65}
66
67?>

このサンプルコードは、PHPにおけるファイルの存在確認方法と、エラー発生時の例外処理の基本を学ぶためのものです。具体的には、file_exists関数とExceptionクラス、そしてException::fileプロパティ（またはgetFile()メソッド）の使い方を解説しています。

file_exists関数は、引数で指定されたファイルパスが存在するかどうかを調べ、その結果を真偽値で返します。サンプルコード内のcheckFileExistenceAndThrowIfMissing関数では、このfile_existsを使ってファイルが存在しない場合にExceptionをスローしています。

Exception::fileプロパティは、例外がスローされたPHPスクリプトのファイルパスを文字列で返します。この情報は、通常getFile()メソッドを通じて取得されます。プログラムの実行中にエラーが発生し、try-catchブロックでExceptionを捕捉した場合、$e->getFile()を呼び出すことで、問題が発生した具体的なPHPファイルの位置を特定でき、エラーのデバッグや原因究明に役立ちます。

このコードは、存在するファイルと存在しないファイルの両方で動作を試し、ファイルが存在しない場合に例外が適切に捕捉され、その例外が発生したスクリプトのパスが$e->getFile()で取得される一連の流れを示しています。これにより、ファイル操作における堅牢なエラーハンドリングの基礎を習得できます。

Copy
1<?php
2
3/**
4 * PHPの組み込みエラーをErrorExceptionとして捕捉するためのエラーハンドラを設定します。
5 * これにより、ファイル操作などで発生するWarningやNoticeもtry-catchブロックで扱えるようになります。
6 */
7set_error_handler(function (int $severity, string $message, string $file, int $line): bool {
8    // ErrorExceptionクラスは、PHPの標準的な例外クラスであるExceptionを継承しています。
9    // 第1引数: エラーメッセージ
10    // 第2引数: エラーコード (ここでは0)
11    // 第3引数: エラーの深刻度 (E_WARNING, E_NOTICEなど)
12    // 第4引数: エラーが発生したファイル名
13    // 第5引数: エラーが発生した行番号
14    throw new \ErrorException($message, 0, $severity, $file, $line);
15});
16
17try {
18    // 存在しないファイルを読み込もうとすることで、意図的にエラーを発生させます。
19    // file_get_contents関数は、ファイルが見つからない場合にWarningを発生させます。
20    // このWarningは、上記で設定したエラーハンドラによってErrorExceptionに変換され、
21    // catchブロックで捕捉されるようになります。
22    file_get_contents('non_existent_file.txt');
23
24} catch (\ErrorException $e) {
25    // ErrorExceptionが捕捉された場合、ここが実行されます。
26
27    // Exceptionクラスの`file`プロパティ（getFile()メソッドでアクセス）は、
28    // 例外が発生したソースコードのファイルパスを返します。
29    // この場合、エラーを発生させたこのスクリプト自身のファイルパスが得られます。
30    $filePath = $e->getFile();
31
32    echo "発生した例外のソースファイルパス: " . $filePath . PHP_EOL;
33    echo "エラーメッセージ: " . $e->getMessage() . PHP_EOL;
34    echo "エラーが発生した行番号: " . $e->getLine() . PHP_EOL;
35
36    // キーワード「filesize」に関連付けて、取得したファイルパスのサイズを計測します。
37    // ここで計測されるのは、このPHPスクリプトファイル自身のサイズです。
38    if (file_exists($filePath)) {
39        $fileSize = filesize($filePath);
40        echo "このスクリプトファイルのサイズ: " . $fileSize . " バイト" . PHP_EOL;
41    } else {
42        echo "ファイルが見つからないため、サイズを取得できませんでした。" . PHP_EOL;
43    }
44
45} catch (\Exception $e) {
46    // ErrorException以外の、より一般的な例外を捕捉する場合の処理です。
47    echo "予期せぬ例外が発生しました: " . $e->getMessage() . PHP_EOL;
48    echo "ファイル: " . $e->getFile() . PHP_EOL;
49    echo "行: " . $e->getLine() . PHP_EOL;
50
51} finally {
52    // 例外の発生有無に関わらず、最後に必ず実行されるブロックです。
53    // ここでは、設定したエラーハンドラを元の状態に戻します。
54    restore_error_handler();
55}
56

PHPのException::fileプロパティは、例外が発生したソースコードのファイルパスを取得するために使用されます。これは通常getFile()メソッドを通じてアクセスし、引数はなく、例外が発生したファイルの絶対パスを文字列として返します。

このサンプルコードでは、まずset_error_handler関数を用いてPHPの警告（Warning）などをErrorExceptionとして捕捉できるように設定しています。これにより、file_get_contents関数で存在しないファイルを読み込もうとした際に発生するWarningも、try-catchブロックで例外として処理できるようになります。

catchブロック内で$e->getFile()を呼び出すと、エラー（この場合はfile_get_contentsの失敗）が発生したこのPHPスクリプトファイル自身のパスが文字列として取得されます。その後、取得したファイルパスを用いてfilesize()関数でスクリプトファイルのサイズを計測し、結果を表示しています。このようにgetFile()は、例外発生時の状況を把握し、デバッグやエラーログに役立つ情報を提供します。