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

Copy
1<?php
2
3/**
4 * DateException::file プロパティと file_exists() 関数を組み合わせたサンプルコード。
5 *
6 * DateException が発生した際に、その例外オブジェクトから例外が発生した
7 * PHPスクリプトのファイルパスを取得し、そのファイルが実際に存在するかどうかを
8 * file_exists() 関数で確認する方法を示します。
9 *
10 * システムエンジニアを目指す初心者向けに、例外処理の基本的な概念と、
11 * ファイルパスの存在確認の応用例を理解することを目的としています。
12 */
13function demonstrateDateExceptionFileAndFileExists(): void
14{
15    echo "--- DateException::file プロパティと file_exists() のデモンストレーション ---" . PHP_EOL;
16
17    try {
18        // 意図的に DateException を発生させます。
19        // DateTimeImmutable のコンストラクタに不正な日付文字列を渡すことで、
20        // DateException (PHP 8 以降) がスローされます。
21        new DateTimeImmutable('this-is-not-a-valid-date-string');
22
23    } catch (DateException $e) {
24        // DateException を捕捉（キャッチ）します。
25        // 例外が発生したときに、ここでその例外オブジェクトを受け取ります。
26        echo "DateException が発生しました。" . PHP_EOL;
27        echo "メッセージ: " . $e->getMessage() . PHP_EOL;
28
29        // DateException オブジェクトから、例外が発生したPHPスクリプトのファイルパスを取得します。
30        // この場合、$e->file はこのスクリプト自身のファイルパスを返します。
31        $exceptionSourceFile = $e->file;
32        echo "例外発生元ファイル: " . $exceptionSourceFile . PHP_EOL;
33
34        // 取得したファイルパスが実際にシステム上に存在するかどうかを file_exists() 関数で確認します。
35        if (file_exists($exceptionSourceFile)) {
36            echo "-> この例外発生元ファイルはシステム上に存在します。" . PHP_EOL;
37        } else {
38            echo "-> この例外発生元ファイルはシステム上に見つかりません。(通常は発生しないケースです)" . PHP_EOL;
39        }
40
41    } finally {
42        // try-catch ブロックの処理が完了した後、必ず実行されるブロックです。
43        echo "--- デモンストレーション終了 ---" . PHP_EOL;
44    }
45}
46
47// 上記で定義した関数を実行します。
48demonstrateDateExceptionFileAndFileExists();
49

このPHPサンプルコードは、日付や時刻の処理でエラーが発生した際に使われる DateException クラスの file プロパティと、ファイルの存在を確認する file_exists() 関数を組み合わせた例です。

コードの中心は try-catch ブロックです。まず try の中で、わざと不正な日付文字列を DateTimeImmutable に渡して DateException を発生させます。発生した例外は catch ブロックで捕捉され、その詳細情報を持つ例外オブジェクトが変数 $e に格納されます。

$e->file は、例外が発生したPHPスクリプトのファイルパスを文字列(string)として取得するプロパティです。このプロパティは引数を必要としません。次に、この取得したファイルパスを file_exists() 関数に渡します。file_exists() 関数は、引数で指定されたファイルが実際に存在するかを調べ、存在すれば true を、しなければ false を返します。

このサンプルでは、例外発生元のファイルパスを取得し、そのファイルが本当にシステム上に存在するかを確認する、という一連の流れを示しています。これは、エラーログを記録する際など、デバッグ作業で役立つ実践的な手法です。

Copy
1<?php
2
3/**
4 * 無効な日付文字列から DateTimeImmutable オブジェクトを生成しようと試み、
5 * 発生した DateException の情報を表示します。
6 *
7 * @param string $invalidDate 無効な日付フォーマットの文字列
8 * @return void
9 */
10function demonstrateDateException(string $invalidDate): void
11{
12    try {
13        // DateException が発生する可能性のあるコード
14        // 無効な日付文字列で DateTimeImmutable をインスタンス化しようとすると、
15        // DateException がスローされます。
16        $date = new DateTimeImmutable($invalidDate);
17        echo "日付オブジェクトの生成に成功しました。\n"; // この行は実行されません
18    } catch (DateException $e) {
19        // 例外(Exception)を捕捉(catch)した場合の処理
20        echo "エラーが発生しました。\n";
21        echo "----------------------------------------\n";
22        // getMessage() でエラーメッセージを取得します。
23        echo "メッセージ: " . $e->getMessage() . "\n";
24
25        // getFile() で例外が発生したファイル名（フルパス）を取得します。
26        // これが DateException->file プロパティの値です。
27        echo "ファイル名: " . $e->getFile() . "\n";
28
29        // getLine() で例外が発生した行番号を取得します。
30        echo "行番号　: " . $e->getLine() . "\n";
31        echo "----------------------------------------\n";
32    }
33}
34
35// 無効な日付文字列を渡して関数を実行します。
36demonstrateDateException('これは不正な日付です');
37
38?>

このPHPサンプルコードは、無効な日付文字列を処理しようとした際に発生する DateException という例外を捕捉し、そのエラー情報を表示する方法を解説しています。

demonstrateDateException 関数内では、try ブロックで new DateTimeImmutable() を使い、PHPが解釈できない文字列から日付オブジェクトの生成を試みます。この処理は失敗するため、DateException が発生し、プログラムの実行は直ちに catch ブロックへ移ります。

catch ブロックでは、発生した例外の情報を持つ DateException オブジェクトを $e という変数で受け取ります。このオブジェクトの getFile() メソッドを呼び出すと、file プロパティに格納されている「例外が発生したファイル名」が、フルパスの文字列として返されます。このメソッドに引数は不要です。

コードの実行結果として表示されるファイル名、getMessage() で取得するエラーメッセージ、getLine() で取得する行番号を組み合わせることで、プログラムのどこで、どのようなエラーが起きたのかを正確に特定でき、デバッグ作業に役立ちます。