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

Copy
1<?php
2
3/**
4 * Dom\XMLDocument クラスを使用してXMLドキュメントを作成し、ファイルに保存するサンプルです。
5 * PHP 8.1 以降で Dom 拡張が利用可能です。
6 */
7function saveXmlDocumentToFileExample(): void
8{
9    // 保存するXMLファイルの名前を定義します。
10    $filename = 'my_sample_document.xml';
11
12    try {
13        // 新しい Dom\XMLDocument オブジェクトを作成します。
14        $document = new Dom\XMLDocument();
15
16        // XML宣言を追加します。これは必須ではありませんが、良い習慣です。
17        $document->loadXml('<?xml version="1.0" encoding="UTF-8"?>');
18
19        // ルート要素（例: <root_element>）を作成し、ドキュメントに追加します。
20        $rootElement = $document->createElement('root_element');
21        $document->appendChild($rootElement);
22
23        // 子要素（例: <message>Hello, PHP XML!</message>）を作成し、ルート要素に追加します。
24        $messageElement = $document->createElement('message', 'Hello, PHP XML!');
25        $rootElement->appendChild($messageElement);
26
27        // 別の要素（例: <item id="1">First Item</item>）と属性を作成し、ルート要素に追加します。
28        $itemElement = $document->createElement('item', 'First Item');
29        $itemElement->setAttribute('id', '1');
30        $rootElement->appendChild($itemElement);
31
32        // XMLドキュメントをファイルに保存します。
33        // saveXmlFileは成功した場合に書き込まれたバイト数を返し、失敗した場合に false を返します。
34        $bytesSaved = $document->saveXmlFile($filename);
35
36        if ($bytesSaved !== false) {
37            echo "XMLドキュメントが '{$filename}' に {$bytesSaved} バイトで正常に保存されました。\n";
38            echo "このファイルは、スクリプトが実行されたディレクトリに作成されています。\n";
39        } else {
40            echo "XMLドキュメントの保存に失敗しました。\n";
41        }
42
43    } catch (Dom\Exception $e) {
44        // Dom 拡張に関連するエラーを捕捉します。
45        echo "XML処理中にエラーが発生しました: " . $e->getMessage() . "\n";
46    } catch (Exception $e) {
47        // その他の予期せぬエラーを捕捉します。
48        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
49    }
50}
51
52// サンプル関数を実行します。
53saveXmlDocumentToFileExample();

PHPのDom\XMLDocument::saveXmlFileメソッドは、プログラム内で構築したXMLドキュメントをファイルに保存する際に使用します。このメソッドはPHP 8.1以降で利用可能なDom拡張の一部であり、Dom\XMLDocumentクラスに属する機能です。

引数としては、第1引数 $filename に保存先のファイル名を文字列で指定します。第2引数 $options は保存時の追加オプションですが、通常はデフォルト値の 0 で問題ありません。

このメソッドは、XMLドキュメントの保存に成功すると、ファイルに書き込まれたバイト数を整数で返します。ファイル作成や書き込み権限の問題などで失敗した場合は false を返します。

サンプルコードでは、まずDom\XMLDocumentオブジェクトを作成し、createElementやappendChildといったメソッドでXMLの要素と構造を組み立てています。その後、saveXmlFileメソッドを呼び出し、指定されたファイル名で構築したXMLドキュメントを保存しています。戻り値を確認することで保存の成否を判断し、適切なメッセージを表示します。また、ファイル操作中に発生しうるDom\Exceptionなどのエラーは、try-catchブロックで捕捉し、安全に処理する仕組みが示されています。

Copy
1<?php
2
3// Dom\XMLDocument クラスは PHP 8 以降で利用可能な新しい DOM 拡張機能です。
4// これは XML ドキュメントを作成、操作、保存するためのクラスです。
5
6/**
7 * 簡単な XML ドキュメントを作成し、指定されたファイルに保存します。
8 *
9 * @param string $filename 保存する XML ファイルのパスと名前。
10 * @return void
11 */
12function createAndSaveSimpleXml(string $filename): void
13{
14    echo "XMLドキュメントを作成し、'{$filename}'に保存します...\n";
15
16    try {
17        // 1. 新しい Dom\XMLDocument インスタンスを作成します。
18        $document = new Dom\XMLDocument();
19
20        // 2. ドキュメントをXMLバージョン1.0、UTF-8エンコーディングで初期化します。
21        //    これにより、XML宣言 (<?xml version="1.0" encoding="UTF-8"?>) が追加されます。
22        $document->createDocument('1.0', 'UTF-8');
23
24        // 3. ルート要素 '<data>' を作成し、ドキュメントに追加します。
25        $rootElement = $document->createElement('data');
26        $document->appendChild($rootElement);
27
28        // 4. 子要素 '<item>' を作成し、ルート要素に追加します。
29        //    テキストコンテンツと属性も設定します。
30        $item1 = $document->createElement('item', 'PHPは素晴らしい');
31        $item1->setAttribute('id', '1');
32        $rootElement->appendChild($item1);
33
34        $item2 = $document->createElement('item', 'XMLファイル保存の例');
35        $item2->setAttribute('id', '2');
36        $rootElement->appendChild($item2);
37
38        // 5. Dom\XMLDocument::saveXmlFile() メソッドを使用して、
39        //    XML ドキュメントをファイルに保存します。
40        //    戻り値は書き込まれたバイト数、または失敗時に false です。
41        $bytesWritten = $document->saveXmlFile($filename);
42
43        if ($bytesWritten !== false) {
44            echo "成功: XMLドキュメントを'{$filename}'に保存しました。書き込みバイト数: {$bytesWritten} バイト\n";
45            echo "--- 保存されたファイルのコンテンツ ---\n";
46            echo file_get_contents($filename) . "\n"; // 保存されたファイルの内容を読み込み表示
47            echo "------------------------------------\n";
48        } else {
49            echo "失敗: XMLドキュメントを'{$filename}'に保存できませんでした。\n";
50        }
51    } catch (Dom\DomException $e) {
52        // XML ドキュメント操作中に発生したエラーを捕捉します。
53        echo "エラー: XML DOM操作中に問題が発生しました: " . $e->getMessage() . "\n";
54    } catch (Throwable $e) {
55        // その他の予期せぬエラーを捕捉します。
56        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
57    } finally {
58        // サンプルコード実行後に生成されたファイルを削除し、クリーンアップします。
59        if (file_exists($filename)) {
60            unlink($filename);
61            echo "クリーンアップ: '{$filename}'を削除しました。\n";
62        }
63    }
64}
65
66// 保存するXMLファイルの名前を指定します。
67$outputXmlFile = 'my_example_document.xml';
68
69// 関数を実行してXMLドキュメントを作成し、ファイルに保存します。
70createAndSaveSimpleXml($outputXmlFile);
71

PHP 8で導入されたDom\XMLDocumentクラスは、XMLドキュメントの生成、操作、そしてファイルへの保存を効率的に行うための新しい拡張機能です。その中のsaveXmlFileメソッドは、プログラム上で構築されたXMLドキュメントを、指定されたファイルに実際に書き出す役割を担います。

このサンプルコードでは、まずDom\XMLDocumentのインスタンスを生成し、createDocumentメソッドでXMLのバージョンとエンコーディングを設定して、基本的なXML宣言を行います。次に、createElementとappendChildメソッドを使用して、<data>というルート要素と、テキストコンテンツやid属性を持つ複数の<item>子要素を作成し、シンプルなXML構造をプログラム上で構築しています。

構築されたXMLドキュメントは、$document->saveXmlFile($filename)を呼び出すことで、$filenameで指定されたファイルパスに保存されます。引数$filenameは保存先のファイル名を文字列で指定し、オプションの$options引数は通常0で、特別な保存設定がない場合に利用されます。このメソッドは、ファイルへの書き込みに成功した場合、実際に書き込まれたバイト数を整数値で返します。万が一、保存に失敗した場合はfalseを返すため、プログラムで保存の成否を確実に判定し、適切なエラーハンドリングを行うことができます。サンプルコードでは、保存後にファイルの内容を表示し、最終的に作成されたファイルを削除してクリーンアップも行っています。