【PHP8.x】Dom\XMLDocument::createFromFile()メソッドの使い方

Copy
1<?php
2
3/**
4 * Dom\XMLDocument::createFromFile メソッドを使用してXMLファイルを読み込むサンプル
5 *
6 * この関数は、指定されたパスからXMLファイルを読み込み、その内容をDom\XMLDocumentオブジェクトとして返します。
7 * 初心者でも理解しやすいように、一時的なXMLファイルを作成し、それを読み込む手順を示します。
8 */
9function loadXmlFromFileExample(): void
10{
11    // 1. テスト用のXMLファイルの内容を定義
12    $xmlContent = <<<XML
13<?xml version="1.0" encoding="UTF-8"?>
14<bookstore>
15  <book category="cooking">
16    <title lang="en">Everyday Italian</title>
17    <author>Giada De Laurentiis</author>
18    <year>2005</year>
19    <price>30.00</price>
20  </book>
21  <book category="children">
22    <title lang="en">Harry Potter</title>
23    <author>J.K. Rowling</author>
24    <year>2005</year>
25    <price>29.99</price>
26  </book>
27</bookstore>
28XML;
29
30    // 2. 一時的なXMLファイルをシステムの一時ディレクトリに作成
31    $tempXmlFilePath = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'example.xml';
32    file_put_contents($tempXmlFilePath, $xmlContent);
33
34    echo "一時XMLファイルが作成されました: " . $tempXmlFilePath . PHP_EOL;
35
36    try {
37        // 3. Dom\XMLDocument::createFromFile() メソッドを使用してXMLファイルを読み込み
38        // 第1引数: 読み込むXMLファイルのパス
39        // 第2引数: オプション (デフォルトは0。XML_PARSE_NOENTなどのフラグを指定可能)
40        $document = Dom\XMLDocument::createFromFile($tempXmlFilePath);
41
42        echo "XMLファイルが正常に読み込まれました。" . PHP_EOL;
43
44        // 4. 読み込んだXMLドキュメントからデータを取得する例
45        // ドキュメント要素 (ルート要素) の名前を表示
46        echo "ルート要素名: " . $document->documentElement->nodeName . PHP_EOL;
47
48        // 最初の 'book' 要素の 'title' を取得して表示
49        $firstBookTitle = $document->getElementsByTagName('book')[0]->getElementsByTagName('title')[0]->textContent;
50        echo "最初の本のタイトル: " . $firstBookTitle . PHP_EOL;
51
52    } catch (Throwable $e) {
53        // ファイルが見つからない、XMLが不正などのエラーを捕捉
54        echo "XMLファイルの読み込み中にエラーが発生しました: " . $e->getMessage() . PHP_EOL;
55    } finally {
56        // 5. 使用した一時ファイルをクリーンアップ (削除)
57        if (file_exists($tempXmlFilePath)) {
58            unlink($tempXmlFilePath);
59            echo "一時XMLファイルが削除されました。" . PHP_EOL;
60        }
61    }
62}
63
64// 関数の実行
65loadXmlFromFileExample();

PHPのDom\XMLDocument::createFromFileメソッドは、指定されたパスにあるXMLファイルを読み込み、その内容を操作可能なDom\XMLDocumentオブジェクトとして提供します。このメソッドはXML処理の基盤となり、外部ファイルからXMLデータをアプリケーションに組み込む際に非常に便利です。

第1引数 $path には、読み込むXMLファイルのパスを文字列で指定します。第2引数 $options は、XMLのパース（解析）方法を制御するためのオプションで、通常は省略可能です。第3引数 $overrideEncoding は、XML宣言で指定されたエンコーディングを強制的に上書きする際に使用しますが、これも通常は省略されます。メソッドが成功すると、XMLの内容を表すDom\XMLDocumentオブジェクトが戻り値として返されます。ファイルが見つからない、またはXMLが不正である場合は、例外がスローされます。

このサンプルコードでは、まず一時的なXMLファイルを作成し、それをcreateFromFileメソッドで読み込んでいます。読み込み後、ドキュメントのルート要素名や最初の本のタイトルを取得する例を示しており、XMLデータへのアクセス方法を理解するのに役立ちます。エラー発生時の例外処理や、一時ファイルを確実に削除するクリーンアップ処理も含まれており、初心者の方でも安全なXMLファイル読み込み処理の実装方法を学ぶことができます。

Copy
1<?php
2
3/**
4 * Dom\XMLDocument::createFromFile メソッドを使用してXMLファイルを読み込み、
5 * その内容を処理する単一の実行可能コードです。
6 * システムエンジニアを目指す初心者向けに、ファイルの準備から読み込み、
7 * エラーハンドリング、簡単なデータアクセスまでの一連の流れを示します。
8 */
9function runXmlFileProcessingExample(): void
10{
11    // =========================================================================
12    // 1. テスト用XMLファイルの準備
13    //    このサンプルコードが単体で動作するよう、一時的なXMLファイルを作成します。
14    //    実際のアプリケーションでは、通常、既存のファイルパスを指定します。
15    // =========================================================================
16    $testFilePath = 'sample_data_for_createfromfile.xml';
17    $xmlContent = <<<XML
18<?xml version="1.0" encoding="UTF-8"?>
19<data>
20    <item id="1">
21        <name>Sample Item One</name>
22        <value>100</value>
23    </item>
24    <item id="2">
25        <name>Sample Item Two</name>
26        <value>200</value>
27    </item>
28</data>
29XML;
30
31    echo "--- PHP Dom\\XMLDocument::createFromFile サンプル開始 ---\n\n";
32    echo "1. テスト用XMLファイル '{$testFilePath}' を作成中...\n";
33    if (file_put_contents($testFilePath, $xmlContent) === false) {
34        echo "   エラー: テスト用XMLファイルの作成に失敗しました。スクリプトを終了します。\n";
35        return; // 関数を終了
36    }
37    echo "   ファイル作成成功。\n\n";
38
39    // =========================================================================
40    // 2. Dom\XMLDocument::createFromFile メソッドを使ったXMLファイルの読み込み
41    // =========================================================================
42    echo "2. Dom\\XMLDocument::createFromFile を使用してXMLファイルを読み込みます。\n";
43    echo "   読み込むファイルパス: {$testFilePath}\n";
44
45    try {
46        // Dom\XMLDocument::createFromFile は、指定されたパスのXMLファイルから
47        // 新しいDom\XMLDocumentオブジェクトを作成します。
48        // 戻り値: 成功した場合は Dom\XMLDocument オブジェクト、失敗した場合は例外をスローします。
49        // 引数:
50        // - string $path: 読み込むXMLファイルへのパス (必須)
51        // - int $options: オプションビットマスク (デフォルトは0。ここではデフォルトを使用)
52        // - ?string $overrideEncoding: エンコーディングを上書きする場合の文字列 (デフォルトはnull。ここではnullを使用)
53        $document = Dom\XMLDocument::createFromFile($testFilePath);
54
55        echo "   XMLファイルを正常に読み込み、Dom\\XMLDocument オブジェクトを作成しました。\n";
56
57        // =====================================================================
58        // 3. 読み込んだXMLドキュメントの内容にアクセスする例
59        //    作成されたDom\XMLDocumentオブジェクトからデータにアクセスします。
60        // =====================================================================
61        echo "3. 読み込んだXMLドキュメントの内容にアクセスします。\n";
62
63        // ドキュメントのルート要素 (<data>) を取得します。
64        $rootElement = $document->documentElement;
65
66        if ($rootElement) {
67            echo "   ルート要素名: " . $rootElement->nodeName . "\n";
68
69            // すべての <item> 要素を取得します。
70            $items = $document->getElementsByTagName('item');
71            echo "   見つかった <item> 要素の数: " . $items->count() . "\n";
72
73            // 最初の <item> 要素にアクセスし、その子要素 <name> のテキストコンテンツと ID 属性を表示します。
74            if ($items->count() > 0) {
75                $firstItem = $items->item(0);
76                if ($firstItem->hasAttribute('id')) {
77                    echo "   - 最初のアイテムのID: " . $firstItem->getAttribute('id') . "\n";
78                }
79                $nameNodes = $firstItem->getElementsByTagName('name');
80                if ($nameNodes->count() > 0) {
81                    echo "   - 最初のアイテムの名前: " . $nameNodes->item(0)->textContent . "\n";
82                }
83            }
84        } else {
85            echo "   エラー: XMLドキュメントにルート要素が見つかりませんでした。\n";
86        }
87
88    } catch (Dom\XMLDocumentException $e) {
89        // XMLのパースエラーやファイルが見つからない（PHPのopen_basedirなどでファイルアクセスが制限されている場合など）
90        // Dom\XMLDocument::createFromFile が失敗した場合に Dom\XMLDocumentException がスローされます。
91        echo "   エラー: XMLドキュメントの読み込み中に例外が発生しました: " . $e->getMessage() . "\n";
92    } catch (Throwable $e) {
93        // その他の予期せぬPHPエラーをキャッチします。
94        echo "   エラー: 予期せぬ例外が発生しました: " . $e->getMessage() . "\n";
95    }
96
97    // =========================================================================
98    // 4. テスト用XMLファイルのクリーンアップ
99    //    作成した一時ファイルを削除し、環境をクリーンに保ちます。
100    // =========================================================================
101    echo "\n4. テスト用XMLファイル '{$testFilePath}' を削除中...\n";
102    if (unlink($testFilePath)) {
103        echo "   ファイル削除成功。\n";
104    } else {
105        echo "   警告: ファイル削除に失敗しました（手動で削除する必要があるかもしれません）。\n";
106    }
107
108    echo "\n--- PHP Dom\\XMLDocument::createFromFile サンプル終了 ---\n";
109
110    // =========================================================================
111    // 補足: 不正なXMLファイルを読み込もうとした場合のエラー処理の例
112    // =========================================================================
113    echo "\n--- 不正なXMLファイル読み込みテスト（エラー発生例）---\n";
114    $invalidXmlFilePath = 'invalid_sample_data.xml';
115    // 意図的に閉じタグを省略した不正なXML
116    $invalidXmlContent = '<?xml version="1.0"?><root><item>Invalid XML</item></root';
117    file_put_contents($invalidXmlFilePath, $invalidXmlContent);
118    echo "不正なXMLファイル '{$invalidXmlFilePath}' を作成し、読み込みを試みます。\n";
119    try {
120        Dom\XMLDocument::createFromFile($invalidXmlFilePath);
121        // この行が実行されることは、通常ありません
122        echo "   エラー: 不正なXMLがエラーなしで読み込まれてしまいました（予期しない動作）。\n";
123    } catch (Dom\XMLDocumentException $e) {
124        echo "   期待通り、不正なXMLファイルでエラーが発生しました: " . $e->getMessage() . "\n";
125    } finally {
126        unlink($invalidXmlFilePath); // 使用後に削除
127        echo "   不正なXMLファイル '{$invalidXmlFilePath}' を削除しました。\n";
128    }
129    echo "--- 不正なXMLファイル読み込みテスト終了 ---\n\n";
130}
131
132// 上記の関数を実行し、サンプルコードを動作させます。
133runXmlFileProcessingExample();
134
135?>

PHPのDom\XMLDocument::createFromFileメソッドは、指定されたパスのXMLファイルを読み込み、その内容を表す新しいDom\XMLDocumentオブジェクトを生成するための静的メソッドです。このメソッドは、XML形式のデータをファイルから読み込み、プログラム内で構造化されたデータとして扱いたい場合に利用されます。

引数としては、まず必須で読み込むXMLファイルへのパスを文字列で指定します。次に、XMLのパース挙動を制御するオプションビットマスクを整数値で指定できますが、通常はデフォルト値の0を使用します。さらに、ファイルのエンコーディングを明示的に上書きしたい場合は、そのエンコーディング名を文字列で指定できます。

このメソッドが成功すると、読み込まれたXML構造をプログラム的に操作できるDom\XMLDocumentオブジェクトが返されます。このオブジェクトを通じて、XMLのルート要素、特定の子要素、属性などにアクセスし、必要なデータを抽出したり操作したりすることが可能になります。

一方、指定されたファイルが見つからない場合や、XMLの書式が不正である場合など、読み込みに失敗した際にはDom\XMLDocumentExceptionがスローされます。そのため、サンプルコードのようにtry-catchブロックを使用して例外を捕捉し、適切なエラーハンドリングを行うことが重要です。

サンプルコードでは、まず一時的なXMLファイルを作成し、そのファイルをcreateFromFileで読み込む一連の流れを具体的に示しています。読み込み成功後には、documentElementプロパティやgetElementsByTagNameメソッドを用いてXMLドキュメント内のデータにアクセスする方法を解説し、エラー発生時の対処法も含まれています。最後に、作成した一時ファイルの削除と、不正なXMLファイル読み込み時のエラー発生例も補足しています。