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

saveXmlFileメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年11月07日

基本的な使い方

saveXmlFileメソッドは、DOMDocumentオブジェクト（この場合はHTMLDocumentオブジェクト）の内容をXMLファイルとして保存するメソッドです。このメソッドを使用することで、メモリ上に構築されたDOMツリーをファイルシステム上にXML形式で永続化できます。引数には、保存先のファイルのパスを指定します。ファイルパスは文字列で指定し、書き込み権限のあるディレクトリを指定する必要があります。

メソッドの実行に成功した場合、保存されたバイト数が返されます。エラーが発生した場合（例えば、ファイルへの書き込み権限がない場合や、指定されたパスが存在しない場合など）はfalseが返されます。

saveXmlFileメソッドは、HTMLDocumentオブジェクトの内容を整形式XMLとして保存することを保証するものではありません。HTMLの構造によっては、XMLとして不正な形式で保存される可能性があります。整形式XMLとして保存したい場合は、事前にDOMDocumentオブジェクトに対して適切な処理（例えば、不要なHTML要素の削除や属性の修正など）を行う必要があります。

このメソッドは、Webスクレイピングなどで取得したHTMLデータを解析し、必要な情報を抽出した後、加工したデータをXMLファイルとして保存する場合などに有用です。また、設定ファイルやデータ交換フォーマットとしてXMLを使用するアプリケーションにおいても、DOMDocumentオブジェクトの内容をファイルに書き出す際に利用できます。

構文(syntax)


1Dom\HTMLDocument::saveXmlFile(string $filename, int $options = 0): int|false

引数(parameters)

string $filename, int $options = 0

string $filename: 保存先のファイルパスを指定する文字列
int $options = 0: 保存時のオプションを指定する整数。デフォルトは0

戻り値(return)

int|false

このメソッドは、HTMLドキュメントをXMLファイルとして保存したバイト数を返します。保存に失敗した場合は false を返します。

サンプルコード

PHP Dom\HTMLDocument::saveXmlFile() でXMLファイル保存


1<?php
2
3// Dom\HTMLDocument クラスを使用してHTMLドキュメントをXMLファイルとして保存するサンプルコードです。
4// このクラスはHTML5の仕様に基づいたパースと操作を提供します。
5
6try {
7    // 1. 新しい Dom\HTMLDocument オブジェクトを作成します。
8    // Dom\HTMLDocument はPHP 8.0で追加された、HTML5を扱うための新しいDOM拡張です。
9    $document = new Dom\HTMLDocument();
10
11    // 2. HTMLコンテンツをドキュメントにロードします。
12    // ここでは簡単なHTML文字列を使用します。
13    $htmlContent = <<<HTML
14<!DOCTYPE html>
15<html>
16<head>
17    <meta charset="utf-8">
18    <title>サンプルドキュメント</title>
19</head>
20<body>
21    <h1>こんにちは、PHP DOM!</h1>
22    <p>この段落はXMLファイルとして保存されます。</p>
23    <ul>
24        <li>アイテム1</li>
25        <li>アイテム2</li>
26    </ul>
27</body>
28</html>
29HTML;
30    $document->loadHTML($htmlContent);
31
32    // 3. 保存するファイル名を指定します。
33    // メソッド名が 'saveXmlFile' なので、慣例として拡張子は '.xml' を使用します。
34    $filename = 'sample_output.xml';
35
36    // 4. Dom\HTMLDocument::saveXmlFile() メソッドを使って、
37    // ドキュメントの内容をXMLファイルとして保存します。
38    // 戻り値は書き込まれたバイト数、または失敗した場合は false です。
39    $bytesWritten = $document->saveXmlFile($filename);
40
41    // 5. 保存結果を確認し、ユーザーにメッセージを表示します。
42    if ($bytesWritten !== false) {
43        echo "ドキュメントは正常に '{$filename}' に保存されました。\n";
44        echo "書き込まれたバイト数: {$bytesWritten}\n";
45        echo "生成されたファイルの中身を確認してください。\n";
46    } else {
47        echo "ドキュメントの '{$filename}' への保存に失敗しました。\n";
48    }
49} catch (Throwable $e) {
50    // 例外が発生した場合、エラーメッセージを表示します。
51    echo "エラーが発生しました: " . $e->getMessage() . "\n";
52}
53
54?>

PHP 8のDom\HTMLDocument::saveXmlFileメソッドは、HTML5ドキュメントの内容をXML形式で指定したファイルに保存するために使用します。このDom\HTMLDocumentクラスはPHP 8.0で導入された新しいDOM拡張で、HTML5の仕様に基づいたドキュメントの解析と操作を可能にします。

saveXmlFileメソッドは、第一引数に保存先のファイル名（string $filename）を受け取ります。これにより、ドキュメントのコンテンツを指定されたパスに保存できます。第二引数の$optionsは省略可能で、保存時の動作を制御しますが、通常はデフォルト値で問題ありません。メソッドが成功すると、ファイルに書き込まれたバイト数が整数値として返されます。もしファイルへの書き込みに失敗した場合は、falseが返されます。

サンプルコードでは、まずDom\HTMLDocumentオブジェクトを作成し、簡単なHTMLコンテンツをロードしています。その後、saveXmlFileメソッドにsample_output.xmlというファイル名を指定して呼び出すことで、ロードされたHTMLドキュメントがXML形式でディスクに保存されます。保存結果は戻り値によって確認され、成功した場合は書き込まれたバイト数とともに、失敗した場合はエラーメッセージとともに表示されます。これにより、HTML構造を保持したXMLファイルとして手軽に出力することが可能です。

Dom\HTMLDocument::saveXmlFileはPHP 8.0以降で利用可能なメソッドです。ファイルを保存する際は、PHPに書き込み権限のある有効なファイルパスを指定し、存在しないディレクトリへの指定は避けてください。このメソッドは成功時に書き込みバイト数を、失敗時にはfalseを返します。そのため、必ず戻り値を厳密にチェックし、保存の成否を判断することが重要です。ファイル書き込みは権限不足などの外部要因で失敗しやすいため、サンプルコードのようにtry-catchブロックで例外を捕捉し、適切にエラーハンドリングを行うことが必須です。また、HTMLコンテンツから構築されたDOMツリーがXML形式でファイルに出力される点も理解しておきましょう。

PHP: DomDocumentのsaveXmlFileでXMLファイル保存


1<?php
2
3/**
4 * Dom\HTMLDocument オブジェクトの内容をXMLファイルとして保存するサンプルコードです。
5 * saveXmlFile メソッドは、HTMLドキュメントをXML形式でファイルに書き出します。
6 *
7 * システムエンジニアを目指す初心者向け:
8 * このコードは、Webページ（HTML）の構造をプログラムで扱い、それをファイルに保存する一例です。
9 * HTMLは本来XMLではないため、HTMLをXMLとして保存すると、タグの閉じ方など一部の厳密さが変わることがあります。
10 * しかし、DOM（Document Object Model）としてロードされたHTMLは、内部的にはXMLツリー構造として扱えるため、
11 * このメソッドでXMLとして保存することが可能です。
12 */
13
14// 1. Dom\HTMLDocument オブジェクトを作成します。
15// これはHTMLドキュメントをメモリ内で表現するためのオブジェクトです。
16$document = new Dom\HTMLDocument();
17
18// 2. HTMLコンテンツをロードします。
19// ここではシンプルなHTML文字列を用意し、それをドキュメントオブジェクトに読み込ませています。
20$htmlContent = <<<HTML
21<!DOCTYPE html>
22<html>
23<head>
24    <meta charset="utf-8">
25    <title>PHP DOM サンプル</title>
26</head>
27<body>
28    <h1>こんにちは、PHP DOM！</h1>
29    <p>このHTMLはDOMオブジェクトとしてロードされ、XMLファイルとして保存されます。</p>
30    <ul>
31        <li>リストアイテム 1</li>
32        <li>リストアイテム 2</li>
33    </ul>
34</body>
35</html>
36HTML;
37
38// loadHTML メソッドでHTML文字列をパースし、ドキュメントオブジェクトに設定します。
39$document->loadHTML($htmlContent);
40
41// 3. 保存するXMLファイルの名前を指定します。
42$outputFilename = 'saved_document.xml';
43
44// 4. saveXmlFile メソッドを使って、HTMLDocumentの内容をXMLファイルとして保存します。
45// 第一引数には保存先のファイルパスを渡します。
46// 第二引数の $options は省略可能で、通常は0で問題ありません。
47// 成功した場合、書き込まれたバイト数が返され、失敗した場合は false が返されます。
48$bytesWritten = $document->saveXmlFile($outputFilename);
49
50// 5. 保存結果を確認し、ユーザーにメッセージを表示します。
51if ($bytesWritten !== false) {
52    echo "XMLファイル '{$outputFilename}' が正常に作成されました。\n";
53    echo "書き込まれたバイト数: {$bytesWritten}\n";
54    echo "このスクリプトを実行したディレクトリにファイルが生成されています。\n";
55} else {
56    echo "XMLファイルの保存に失敗しました。\n";
57    echo "ファイルパスの権限やディスクスペースを確認してください。\n";
58}
59
60?>

Dom\HTMLDocument::saveXmlFileは、Webページ（HTML）の構造をメモリ上で扱うDom\HTMLDocumentオブジェクトの内容を、XML形式のファイルとして保存するメソッドです。このメソッドは、HTMLをDOMとしてロードすると内部的にはXMLツリー構造として扱えるため、本来XMLではないHTMLをXMLとしてファイルに書き出すことが可能です。

サンプルコードでは、まずDom\HTMLDocumentオブジェクトを作成し、loadHTMLメソッドで簡単なHTML文字列を読み込ませています。次に、saveXmlFileメソッドを呼び出して、このHTMLドキュメントの内容をsaved_document.xmlというファイル名で保存します。

第一引数$filenameには保存先のファイルパスを文字列で指定し、第二引数$optionsはオプションを指定する整数値ですが、通常は0で問題ありません。メソッドの戻り値は、保存に成功した場合は書き込まれたバイト数（int）が返され、失敗した場合はfalseが返されます。コードの最後では、この戻り値を確認し、ファイルが正常に保存されたか、または失敗したかをメッセージで表示しています。これにより、ファイル操作の成否をユーザーが確認できます。

HTMLドキュメントをXML形式で保存する際、HTMLはXMLよりも構文が柔軟なため、出力されるXMLは元のHTMLとは異なる厳密な表現になる場合があります。例えば、閉じタグが省略可能なHTML要素もXMLでは明示的に閉じられることがあります。ファイルを保存するディレクトリには、PHPスクリプトを実行するユーザーからの書き込み権限が必要です。権限がない場合や指定されたファイルパスが正しくない場合、ファイルの保存に失敗します。saveXmlFileメソッドは、保存に成功すると書き込まれたバイト数を、失敗するとfalseを返しますので、戻り値を必ず確認し、ファイルが正常に保存されたか判断するエラーハンドリングを実装してください。