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

Copy
1<?php
2
3/**
4 * 指定されたファイルパスの存在を確認し、その結果を表示します。
5 *
6 * この関数は、システムエンジニアを目指す初心者向けに、
7 * PHPの file_exists() 関数の基本的な使い方を簡潔に示します。
8 *
9 * @param string $filePath 確認するファイルのパス。
10 * @return void
11 */
12function checkFileExistence(string $filePath): void
13{
14    // file_exists() 関数を使用して、指定されたファイルが存在するかどうかをチェックします。
15    if (file_exists($filePath)) {
16        echo "ファイル '{$filePath}' は存在します。\n";
17    } else {
18        echo "ファイル '{$filePath}' は存在しません。\n";
19        // ファイルが存在しない場合、必要に応じてファイルを作成する処理などを追加できます。
20        // 例: touch($filePath); // この行を有効にすると、存在しない場合にファイルを作成します。
21    }
22}
23
24// ----------------------------------------------------
25// 関数の使用例
26// ----------------------------------------------------
27
28// 1. このスクリプト自身のファイルパスをチェックする例
29// __FILE__ は現在のスクリプトのフルパスを示すPHPの組み込み定数です。
30$currentScriptPath = __FILE__;
31echo "--- 存在するファイルのチェック ---\n";
32checkFileExistence($currentScriptPath);
33echo "\n";
34
35// 2. 存在しないであろうファイルパスをチェックする例
36$nonExistentFilePath = 'non_existent_dummy_file.txt';
37echo "--- 存在しないファイルのチェック ---\n";
38checkFileExistence($nonExistentFilePath);
39echo "\n";
40
41// 3. 一時的にファイルを作成し、その後削除するデモンストレーション
42$tempFilePath = 'temporary_test_file.txt';
43echo "--- 一時ファイルの作成と削除のデモンストレーション ---\n";
44
45echo "ファイルを操作する前: \n";
46checkFileExistence($tempFilePath);
47
48echo "一時ファイル '{$tempFilePath}' を作成します...\n";
49if (touch($tempFilePath)) { // touch() は空のファイルを作成します
50    echo "作成後: \n";
51    checkFileExistence($tempFilePath);
52
53    echo "一時ファイル '{$tempFilePath}' を削除します...\n";
54    unlink($tempFilePath); // unlink() はファイルを削除します
55    echo "削除後: \n";
56    checkFileExistence($tempFilePath);
57} else {
58    echo "一時ファイル '{$tempFilePath}' の作成に失敗しました。\n";
59}
60
61?>

このサンプルコードは、PHPのfile_exists()関数を用いて、指定されたパスにファイルやディレクトリが存在するかどうかを効率的に確認する方法を、システムエンジニアを目指す初心者の方にも分かりやすく説明しています。file_exists()関数は、確認したいファイルまたはディレクトリのパスを文字列として引数に取ります。この関数は、パスが存在すれば真（true）を、存在しなければ偽（false）を戻り値として返します。

コード内のcheckFileExistence関数は、このfile_exists()の戻り値を利用して、ファイルの存在状況に応じて適切なメッセージを表示する基本的な処理をカプセル化しています。具体的な使用例として、まず現在実行中のスクリプト自身のファイルパス（__FILE__）をチェックし、ファイルが存在することを確認します。次に、意図的に存在しないファイルパスを指定して、ファイルが存在しない場合の挙動を示します。

さらに、touch()関数で一時的なファイルを作成し、その後にunlink()関数で削除するという一連のデモンストレーションを含んでいます。この手順の中でfile_exists()を繰り返し使用することで、ファイル操作の前後でその存在状況をどのように確認できるかを実践的に示しています。これにより、PHPでのファイル操作における基本的な存在確認の重要性と、その利用方法を習得することができます。

Copy
1<?php
2
3/**
4 * DateInvalidTimeZoneExceptionを意図的に発生させる関数。
5 * この関数を呼び出すことで、例外ハンドリングのデモンストレーションを行います。
6 *
7 * @throws DateInvalidTimeZoneException
8 */
9function simulateInvalidTimeZoneOperation(): void
10{
11    // DateInvalidTimeZoneExceptionは通常、不正なタイムゾーンデータや操作によって
12    // PHPの内部で発生しますが、ここではデモンストレーションのために直接スローします。
13    throw new DateInvalidTimeZoneException('無効なタイムゾーン設定が検出されました。');
14}
15
16// 例外処理ブロック
17try {
18    simulateInvalidTimeZoneOperation();
19} catch (DateInvalidTimeZoneException $e) {
20    // DateInvalidTimeZoneException がキャッチされた場合の処理
21
22    echo "DateInvalidTimeZoneException が発生しました。\n";
23    echo "メッセージ: " . $e->getMessage() . "\n";
24
25    // 'file' プロパティは、例外が発生したファイル名（フルパス）を保持します。
26    $exceptionOccurredFile = $e->file;
27    echo "発生ファイル: " . $exceptionOccurredFile . "\n";
28    echo "発生行: " . $e->getLine() . "\n";
29
30    // キーワード 'file_get_contents' に関連付けて、
31    // 例外が発生したファイルの最初の数行を読み込み表示します。
32    // 通常、これは現在実行中のスクリプト自身のソースコードになります。
33    if (file_exists($exceptionOccurredFile) && is_readable($exceptionOccurredFile)) {
34        echo "\n--- 例外が発生したファイルの冒頭を読み込みます ---\n";
35        // ファイルの最初の200文字までを読み込む
36        $fileContent = file_get_contents($exceptionOccurredFile, false, null, 0, 200);
37        if ($fileContent !== false) {
38            echo $fileContent . (strlen($fileContent) == 200 ? "...\n" : "\n");
39        } else {
40            echo "ファイルの読み込みに失敗しました。\n";
41        }
42    } else {
43        echo "\n例外発生ファイル ('{$exceptionOccurredFile}') が存在しないか、読み込めません。\n";
44    }
45
46} catch (Throwable $e) {
47    // 予期せぬ他の種類の例外をキャッチ
48    echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
49}

PHP 8のDateInvalidTimeZoneExceptionクラスは、日付や時刻の処理で無効なタイムゾーンが指定された際に発生する例外です。このクラスが持つfileプロパティは、例外が発生したPHPスクリプトのファイル名（フルパス）を保持しています。このプロパティは引数を取らず、例外発生元のファイル名を文字列として提供します。

サンプルコードでは、simulateInvalidTimeZoneOperation関数で意図的にDateInvalidTimeZoneExceptionを発生させ、try-catchブロックで捕捉しています。例外が捕捉されると、$e->fileを通じて例外が発生したファイル名を取得し、そのパスを表示します。さらに、PHPの標準関数であるfile_get_contentsを利用して、このfileプロパティが指し示すファイルの冒頭部分を読み込み、表示するデモンストレーションを行っています。file_get_contentsは、指定されたファイルの内容を文字列として取得する関数で、ここでは例外発生箇所のコードスニペットを表示し、エラーの原因特定に役立てる例として利用されています。