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

Copy
1<?php
2
3/**
4 * ファイルの存在チェック関数 `file_exists()` の基本的な使用方法と、
5 * `DateMalformedPeriodStringException` からファイルパスを取得し、
6 * それを `file_exists()` で確認する例を示します。
7 *
8 * システムエンジニアを目指す初心者向けに、ファイルシステム操作の基本と
9 * 例外処理におけるファイルパスの取得方法を簡潔に示します。
10 */
11function demonstrateFileExistenceAndExceptionFile(): void
12{
13    // このスクリプトファイル自身のパスを取得
14    $currentScriptPath = __FILE__;
15
16    // 存在しないファイルパスを定義（ユニークな名前で衝突を避ける）
17    $nonExistentFilePath = './temp_non_existent_file_' . uniqid() . '.txt';
18
19    echo "--- file_exists() の基本的な使用例 ---\n";
20
21    // 1. 実行中のスクリプトファイルが存在するか確認
22    if (file_exists($currentScriptPath)) {
23        echo "ファイル '{$currentScriptPath}' は存在します。\n";
24    } else {
25        echo "ファイル '{$currentScriptPath}' は存在しません。\n";
26    }
27
28    // 2. 存在しないファイルが存在するか確認
29    if (file_exists($nonExistentFilePath)) {
30        echo "ファイル '{$nonExistentFilePath}' は存在します。\n";
31    } else {
32        echo "ファイル '{$nonExistentFilePath}' は存在しません。\n";
33    }
34
35    echo "\n--- DateMalformedPeriodStringException と getFile() メソッドの関連例 ---\n";
36    echo "（`DateMalformedPeriodStringException` の `file` プロパティは `getFile()` メソッドでアクセスされます）\n";
37
38    // DateMalformedPeriodStringException を意図的に発生させる
39    // `DatePeriod` コンストラクタに不正な期間文字列を渡す
40    try {
41        // 'INVALID_PERIOD_STRING' は `DatePeriod` が期待する ISO 8601 期間文字列ではないため、
42        // `DateMalformedPeriodStringException` がスローされます。
43        new DatePeriod('INVALID_PERIOD_STRING', new DateTime(), 0);
44
45    } catch (DateMalformedPeriodStringException $e) {
46        echo "DateMalformedPeriodStringException が捕捉されました。\n";
47
48        // 例外が発生したスクリプトのファイルパスを取得
49        // `DateMalformedPeriodStringException` は `Exception` を継承しており、
50        // `getFile()` メソッドは例外がスローされたスクリプトのファイルパス（`string`型）を返します。
51        $exceptionFilePath = $e->getFile();
52        echo "例外が発生したファイル: {$exceptionFilePath}\n";
53
54        // 取得したファイルパスが存在するかどうかを `file_exists()` で確認
55        if (file_exists($exceptionFilePath)) {
56            echo "file_exists() で確認: 例外が発生したファイル '{$exceptionFilePath}' は存在します。\n";
57            echo "これは、現在実行中のスクリプトファイル自身なので当然存在します。\n";
58        } else {
59            echo "file_exists() で確認: 例外が発生したファイル '{$exceptionFilePath}' は存在しません。\n";
60        }
61
62    } catch (Exception $e) {
63        // `DateMalformedPeriodStringException` 以外の予期しない例外を捕捉する場合
64        echo "予期せぬ例外: " . $e->getMessage() . "\n";
65    }
66}
67
68// 関数を実行して、ファイル存在チェックと例外処理の例を表示
69demonstrateFileExistenceAndExceptionFile();

このコードは、PHPのファイルシステム操作における基本的なファイル存在チェックと、例外処理で発生元のファイルパスを取得する方法を学ぶためのサンプルです。

file_exists() 関数は、引数に指定されたファイルパスやディレクトリパスが存在するかどうかを真偽値（trueまたはfalse）で返します。これにより、プログラムがファイルにアクセスする前にその存在を確認できます。

DateMalformedPeriodStringException は、DatePeriodクラスのコンストラクタにISO 8601形式ではない不正な期間文字列が渡された際に発生する特定の例外です。この例外クラスは、PHPの標準的なExceptionクラスを継承しており、例外が発生したスクリプトのファイルパスを取得するためのgetFile()メソッド（リファレンス情報ではfileプロパティとして示されるもの）を提供します。

getFile() メソッドは引数を取りませんが、例外が発生したPHPファイルのパスを文字列（string）として返します。サンプルコードでは、file_exists() の基本を説明した後、意図的にDateMalformedPeriodStringExceptionを発生させて捕捉しています。そして、捕捉した例外オブジェクトのgetFile()メソッドでファイルパスを取得し、そのパスが本当に存在するかをfile_exists()で検証しています。これは、例外発生時のデバッグ情報としてファイルパスがどのように利用できるかを示す良い例です。

Copy
1<?php
2
3// 一時ファイルを作成し、date_period_create_from_string が解析できない不正な日付期間文字列を書き込みます
4$tempFilePath = __DIR__ . '/malformed_period_string.txt';
5// PHPのDate/Time拡張で期待される期間文字列の形式ではない、不正な文字列の例
6$malformedString = 'R/invalid-period-string'; 
7
8// file_put_contents は指定された内容をファイルに書き込むための関数です
9file_put_contents($tempFilePath, $malformedString);
10
11try {
12    // file_get_contents を使用して、作成した一時ファイルの内容を読み込みます
13    // この読み込んだ文字列が、DateMalformedPeriodStringException の原因となります
14    $periodString = file_get_contents($tempFilePath);
15
16    echo "ファイルから読み込んだ文字列: '" . $periodString . "'" . PHP_EOL;
17
18    // date_period_create_from_string 関数に不正な文字列を渡して、DatePeriod オブジェクトを作成しようとします
19    // 不正な文字列のため、DateMalformedPeriodStringException がスローされます
20    $period = date_period_create_from_string($periodString);
21
22    // 例外がスローされれば、以下の行には到達しません
23    echo "DatePeriod オブジェクトが正常に作成されました。\n";
24
25} catch (DateMalformedPeriodStringException $e) {
26    // DateMalformedPeriodStringException を捕捉した場合の処理
27    echo "DateMalformedPeriodStringException が発生しました。\n";
28
29    // 例外オブジェクトの 'file' プロパティは、例外がスローされたPHPスクリプトのファイルパスを返します
30    echo "例外発生元ファイル: " . $e->getFile() . PHP_EOL;
31
32    // 例外メッセージを表示します
33    echo "エラーメッセージ: " . $e->getMessage() . PHP_EOL;
34
35    // どの文字列が原因で例外が発生したかを示します
36    echo "処理しようとした不正な期間文字列: '" . $periodString . "'" . PHP_EOL;
37
38} catch (Exception $e) {
39    // その他の予期せぬ例外を捕捉した場合の処理
40    echo "予期せぬ例外が発生しました: " . $e->getMessage() . PHP_EOL;
41} finally {
42    // 処理の終了後、作成した一時ファイルを必ず削除します
43    // file_exists でファイルの存在を確認し、unlink で削除します
44    if (file_exists($tempFilePath)) {
45        unlink($tempFilePath);
46        echo "一時ファイル '" . basename($tempFilePath) . "' を削除しました。\n";
47    }
48}

PHPのDateMalformedPeriodStringExceptionクラスのfileプロパティは、日付期間の処理中に不正な文字列が原因で例外が発生した際、その例外がスローされたPHPスクリプトのファイルパスを取得するために使用されます。このプロパティには引数はなく、呼び出すと常に例外発生元のファイルパスを文字列として返します。

提供されたサンプルコードでは、まずfile_put_contents関数を使用して、date_period_create_from_stringが処理できない不正な日付期間文字列を一時ファイルに書き込みます。次に、file_get_contents関数でその一時ファイルの内容を読み込み、読み込んだ不正な文字列をdate_period_create_from_string関数に渡すことで、意図的にDateMalformedPeriodStringExceptionを発生させています。

例外が捕捉されたcatchブロックでは、$e->getFile()としてfileプロパティにアクセスし、その結果を画面に表示しています。これにより、どのファイルで例外が発生したか（この場合はサンプルコード自身のファイルパス）を正確に知ることができ、エラーの発生源を特定し、デバッグ作業を進める上で非常に役立ちます。fileプロパティは、例外発生時の状況を把握するための重要な情報を提供します。