【PHP8.x】saveHTMLメソッドの使い方

Copy
1<?php
2
3// DOMDocument を生成
4$dom = new DOMDocument('1.0', 'UTF-8');
5
6// ルート要素を生成
7$root = $dom->createElement('root');
8$dom->appendChild($root);
9
10// 子要素を生成
11$child = $dom->createElement('child', 'テキスト');
12$root->appendChild($child);
13
14// DOMDocument 全体を HTML として文字列に保存
15$html = $dom->saveHTML();
16
17// 結果を出力
18if ($html !== false) {
19    echo $html . PHP_EOL;
20} else {
21    echo "HTML の保存に失敗しました。" . PHP_EOL;
22}
23
24// 特定のノードを HTML として文字列に保存
25$html_child = $dom->saveHTML($child);
26
27// 結果を出力
28if ($html_child !== false) {
29    echo $html_child . PHP_EOL;
30} else {
31    echo "HTML の保存に失敗しました。" . PHP_EOL;
32}
33?>

PHPのDOMDocumentクラスのsaveHTMLメソッドは、DOMドキュメントまたは指定されたノードをHTML文字列として取得するために使用します。このメソッドは、PHP 8で利用可能です。

まず、DOMDocumentオブジェクトを作成し、必要な要素をcreateElementやappendChildなどのメソッドを使って構築します。サンプルコードでは、ルート要素rootとその子要素childを生成しています。

saveHTML()を引数なしで呼び出すと、DOMDocument全体がHTML文字列として返されます。もし、特定のノードのみをHTMLとして取得したい場合は、そのノードオブジェクトを引数$nodeに渡します。サンプルコードでは、$dom->saveHTML($child)でchild要素のみをHTML文字列として取得しています。$nodeはnullableな引数であるため、nullを渡すことも可能ですが、これは引数なしでsaveHTML()を呼び出すのと同じ結果になります。

saveHTML()メソッドは、成功した場合はHTML文字列を、失敗した場合はfalseを返します。そのため、返り値がfalseでないことを確認してから結果を出力する必要があります。サンプルコードでは、返り値がfalseかどうかをif文で確認し、エラーメッセージを表示するか、HTML文字列を出力するかを決定しています。

Copy
1<?php
2
3/**
4 * HTML ドキュメントを UTF-8 で保存するサンプル
5 *
6 * @param string $html HTML 文字列
7 * @return string|false 保存された HTML 文字列、または失敗した場合 false
8 */
9function saveHtmlUtf8(string $html): string|false
10{
11    $dom = new DOMDocument('1.0', 'UTF-8');
12    $dom->loadHTML(mb_convert_encoding($html, 'HTML-ENTITIES', 'UTF-8'));
13    $dom->formatOutput = true;
14
15    return $dom->saveHTML();
16}
17
18// 使用例
19$html = '<p>こんにちは、世界！</p>';
20$savedHtml = saveHtmlUtf8($html);
21
22if ($savedHtml !== false) {
23    echo $savedHtml;
24} else {
25    echo "HTML の保存に失敗しました。";
26}

PHPのDOMDocumentクラスのsaveHTMLメソッドは、DOMドキュメントをHTML文字列として保存するために使用されます。このメソッドは、引数としてオプションでDOMNodeオブジェクトを受け取ることができます。引数が指定された場合、そのノード以下の部分木のみが保存されます。引数がnullまたは省略された場合、ドキュメント全体が保存されます。

サンプルコードでは、HTMLドキュメントをUTF-8エンコーディングで保存するsaveHtmlUtf8関数を定義しています。この関数は、HTML文字列を受け取り、DOMDocumentオブジェクトを作成してHTMLをロードします。mb_convert_encoding関数を使用して、入力HTMLをHTMLエンティティに変換し、UTF-8エンコーディングを維持しています。$dom->formatOutput = true;とすることで、出力されるHTMLが整形されます。

saveHTMLメソッドは、保存されたHTML文字列を返します。保存に失敗した場合はfalseを返します。サンプルコードでは、戻り値がfalseでないことを確認し、保存されたHTMLを出力しています。この関数を利用することで、HTMLをUTF-8エンコーディングで確実に保存し、ウェブページなどで正しく表示できます。saveHTMLメソッドは、HTMLをファイルに保存するsaveHTMLFileメソッドとは異なり、文字列としてHTMLを取得する際に利用します。