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

Copy
1<?php
2
3/**
4 * DOMDocument のロード失敗時に DOMException を発生させ、
5 * その例外の 'file' プロパティと 'file_exists' 関数をデモンストレーションします。
6 *
7 * DOMException::file プロパティは、例外がスローされたPHPスクリプトのファイルパスを返します。
8 * file_exists() 関数は、指定されたファイルやディレクトリが存在するかどうかをチェックします。
9 *
10 * @param string $filePath ロードを試みるファイルパス。通常は存在しないファイルを指定し、
11 *                         DOMExceptionの発生と file_exists() の結果を示します。
12 * @return void
13 */
14function demonstrateDomExceptionFileAndFileExists(string $filePath): void
15{
16    echo "--- ファイル存在チェックの開始 ---\n";
17    echo "  ロードを試みるファイル: '{$filePath}'\n";
18
19    $dom = new DOMDocument();
20
21    try {
22        // DOMDocument::load() はファイルが見つからない場合、通常は警告を発して false を返します。
23        // ここでは @ 演算子を使用して警告を抑制し、戻り値でエラーを判断します。
24        // そして、DOMException の 'file' プロパティのデモンストレーションのために、
25        // 意図的に DOMException をスローします。
26        if (!@$dom->load($filePath)) {
27            // ロードに失敗した場合、DOMException をスローします。
28            // DOMException::file プロパティは、この例外がスローされた
29            // PHPスクリプト自身のファイル名を返します。
30            throw new DOMException(
31                "ファイル '{$filePath}' のロードに失敗しました。ファイルが存在しない可能性があります。",
32                1001 // エラーコード
33            );
34        }
35
36        echo "  ファイル '{$filePath}' のロードに成功しました。\n";
37
38    } catch (DOMException $e) {
39        echo "  DOMException が捕捉されました。\n";
40        echo "    メッセージ: " . $e->getMessage() . "\n";
41        echo "    エラーコード: " . $e->getCode() . "\n";
42        
43        // DOMException::file プロパティから、例外が発生したPHPスクリプトのファイル名を取得します。
44        $errorScriptFile = $e->getFile();
45        echo "    エラーが発生したPHPファイル (DOMException::file): '{$errorScriptFile}'\n";
46
47        // file_exists() を使用して、DOMException::file が示すPHPスクリプトファイルが
48        // 実際に存在するかどうかを確認します。
49        if (file_exists($errorScriptFile)) {
50            echo "    - 例外が発生したスクリプトファイル ('{$errorScriptFile}') は存在します。\n";
51        } else {
52            echo "    - 例外が発生したスクリプトファイル ('{$errorScriptFile}') は存在しません。（これは通常ありえません）\n";
53        }
54
55        // ロードを試みたファイルが存在するかどうかを file_exists() で確認します。
56        if (file_exists($filePath)) {
57            echo "    - ロードを試みたファイル ('{$filePath}') は存在します。\n";
58        } else {
59            echo "    - ロードを試みたファイル ('{$filePath}') は存在しません。\n";
60        }
61
62    } catch (\Exception $e) {
63        // DOMException 以外の一般的な例外も捕捉するフォールバック
64        echo "  一般的な例外が捕捉されました: " . $e->getMessage() . "\n";
65    }
66
67    echo "--- ファイル存在チェックの終了 ---\n\n";
68}
69
70// 存在しないファイル名を指定して関数を実行し、DOMException::file と file_exists() の動作を示します。
71demonstrateDomExceptionFileAndFileExists('non_existent_document.xml');
72
73// (必要であれば) 存在するファイルを指定して、成功時のパスも確認できますが、
74// 主にDOMExceptionとfile_exists()の組み合わせを示すため、エラーパスが中心です。
75// 例:
76// file_put_contents('test_document.xml', '<root><item/></root>');
77// demonstrateDomExceptionFileAndFileExists('test_document.xml');
78// unlink('test_document.xml'); // テストファイルを削除

PHPのDOMExceptionクラスに属するfileプロパティは、例外がスローされたPHPスクリプト自身のファイルパスを文字列として返します。引数はなく、常に文字列型のパスを戻り値とします。一方、file_exists()関数は、引数で指定されたファイルやディレクトリが実際に存在するかどうかを真偽値（true/false）で確認する際に使用します。

提供されたサンプルコードでは、DOMDocumentで存在しないXMLファイルのロードを試み、その失敗を検出した際に意図的にDOMExceptionをスローしています。この例外が捕捉されると、DOMException::fileプロパティ（$e->getFile()）から、現在実行中のPHPスクリプト自身のファイルパスが文字列として取得されます。その後、file_exists()関数を使って、この例外発生元のスクリプトファイルパス、および最初にロードを試みたファイルパスがそれぞれ実際に存在するかどうかを判定しています。これにより、DOMException::fileがエラー発生源のスクリプトファイルパスを提供し、file_exists()がそのパスや他のファイルの存在確認に役立つ様子を具体的に理解し、エラー発生時のファイルの状態を把握する方法を示しています。

Copy
1<?php
2
3/**
4 * DOMException の file プロパティの使用例を示します。
5 *
6 * この関数は、`file_get_contents` でファイルの読み込みを試み、
7 * その結果（失敗した場合は空文字列）を `DOMDocument::loadXML()` に渡すことで、
8 * 意図的に `DOMException` を発生させます。
9 * 例外発生時に `DOMException::file` プロパティにアクセスし、その値を出力します。
10 * `DOMException::file` は、例外がスローされたPHPスクリプトのファイルパスを示します。
11 */
12function demonstrateDomExceptionFileProperty(): void
13{
14    // 存在しないファイルパスを定義し、ファイル読み込みを試みます。
15    // '@' 演算子でファイルが存在しない場合の警告を抑制します。
16    $nonExistentFilePath = 'non_existent_document.xml';
17    $xmlContent = @file_get_contents($nonExistentFilePath);
18
19    // `file_get_contents` が失敗した場合は `false` を返します。
20    // `DOMDocument::loadXML()` は文字列を期待するため、空文字列に変換します。
21    // `DOMDocument::loadXML('')` は PHP 8 で `DOMException` をスローする場合があります。
22    if ($xmlContent === false) {
23        $xmlContent = '';
24        echo "注意: ファイル '{$nonExistentFilePath}' が見つかりませんでした。\n";
25        echo "      DOMDocument::loadXML() に空のコンテンツを渡します。\n\n";
26    }
27
28    try {
29        $dom = new DOMDocument();
30        // 不正なXMLコンテンツ（または空文字列）をロードしようと試みます。
31        // これにより、DOMException が発生することが期待されます。
32        $dom->loadXML($xmlContent);
33
34        // 例外が発生しなかった場合の処理
35        echo "XMLが正常にロードされました (DOMException は発生しませんでした)。\n";
36        echo "これは、`DOMDocument::loadXML()` が空のコンテンツを許容したことを意味します。\n";
37    } catch (DOMException $e) {
38        // DOMException が発生した場合の処理
39        echo "DOMException が発生しました！\n";
40        echo "---------------------------------\n";
41        echo "エラーメッセージ: " . $e->getMessage() . "\n";
42        // DOMException::file プロパティにアクセスし、値を出力します。
43        // これは、例外がスローされたPHPスクリプト自身のファイルパスです。
44        echo "発生ファイル: " . $e->getFile() . "\n";
45        echo "発生行: " . $e->getLine() . "\n";
46        echo "---------------------------------\n";
47        echo "補足: '発生ファイル' は、このPHPスクリプトのファイルパスです。\n";
48        echo "      '{$nonExistentFilePath}' (読み込みを試みた外部ファイル) ではありません。\n";
49    } catch (Throwable $e) {
50        // その他の予期せぬ例外をキャッチします。
51        echo "予期せぬエラーが発生しました。\n";
52        echo "エラーメッセージ: " . $e->getMessage() . "\n";
53        echo "発生ファイル: " . $e->getFile() . "\n";
54        echo "発生行: " . $e->getLine() . "\n";
55    }
56}
57
58// 関数の実行
59demonstrateDomExceptionFileProperty();

PHPのDOMExceptionクラスのfileプロパティは、例外が発生したPHPスクリプトのファイルパスを示す情報を提供します。このプロパティは引数を取りません。戻り値は、例外がスローされたPHPスクリプトの絶対パスを表す文字列です。

このサンプルコードでは、意図的にDOMExceptionを発生させることで、fileプロパティの挙動を示しています。まず、file_get_contents関数で存在しないファイルの読み込みを試み、その結果（ファイルが見つからないため空文字列）をDOMDocument::loadXML()メソッドに渡します。PHP 8では、不正なXMLや空のコンテンツをDOMDocument::loadXML()に渡すとDOMExceptionがスローされる場合があります。

例外がtry-catchブロックで捕捉された際、catchブロック内でDOMException::fileプロパティにアクセスし、その値を出力しています。出力されるファイルパスは、DOMExceptionがスローされたPHPスクリプト自身のパスであり、読み込みを試みた外部ファイルのパスではありません。このプロパティは、プログラムのデバッグ時に例外の発生源となったスクリプトファイルを特定する際に役立ちます。