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

Copy
1<?php
2
3/**
4 * Dom\XMLDocument クラスの formatOutput プロパティの使用例を示します。
5 *
6 * formatOutput プロパティは、XML文書を文字列として出力する際に、
7 * 整形（インデントと改行）を行うかどうかを制御します。
8 * PHP 8の新しいDOM拡張で導入された Dom\XMLDocument クラスを使用します。
9 */
10function demonstrateXmlFormatOutput(): void
11{
12    // Dom\XMLDocument クラスのインスタンスを作成します。
13    // これはXML文書を構築および操作するためのオブジェクトです。
14    $dom = new Dom\XMLDocument();
15
16    // XML宣言のバージョンとエンコーディングを設定します。
17    // formatOutputの動作に直接関係ありませんが、一般的なXML文書には必要です。
18    $dom->xmlVersion = '1.0';
19    $dom->encoding = 'UTF-8';
20
21    // ルート要素（例: <root>）を作成し、文書に追加します。
22    $root = $dom->createElement('root');
23    $dom->appendChild($root);
24
25    // 子要素（例: <item>データ1</item>）を作成し、ルート要素に追加します。
26    $item1 = $dom->createElement('item', 'データ1');
27    $root->appendChild($item1);
28
29    // 別の子要素を追加します。
30    $item2 = $dom->createElement('item', 'データ2');
31    $root->appendChild($item2);
32
33    echo "--- formatOutput が false の場合 (デフォルト動作) ---" . PHP_EOL;
34    // デフォルトでは formatOutput は false です。
35    // saveXML() はXMLを一行に圧縮して出力します。
36    echo $dom->saveXML() . PHP_EOL . PHP_EOL;
37
38    // formatOutput プロパティを true に設定します。
39    // これにより、XMLが出力時に自動的に整形（インデントと改行）されます。
40    $dom->formatOutput = true;
41    echo "--- formatOutput が true の場合 ---" . PHP_EOL;
42    // 整形されたXMLが出力されます。人間が読みやすくなります。
43    echo $dom->saveXML() . PHP_EOL . PHP_EOL;
44
45    // formatOutput プロパティの現在の値を取得することもできます。
46    $isFormatted = $dom->formatOutput;
47    echo "現在の formatOutput の値: " . ($isFormatted ? 'true' : 'false') . PHP_EOL . PHP_EOL;
48
49    // 再び formatOutput を false に設定すると、整形されずに元の状態に戻ります。
50    $dom->formatOutput = false;
51    echo "--- formatOutput を false に戻した場合 ---" . PHP_EOL;
52    echo $dom->saveXML() . PHP_EOL . PHP_EOL;
53}
54
55// 関数を実行して、Dom\XMLDocument の formatOutput プロパティの動作を確認します。
56demonstrateXmlFormatOutput();

Dom\XMLDocumentクラスのformatOutputプロパティは、PHP 8で導入された新しいDOM拡張において、XML文書を文字列として出力する際の整形方法を制御するブール型のプロパティです。このプロパティにtrueを設定すると、saveXML()などのメソッドでXML文書を出力する際に、自動的に適切なインデントと改行が適用され、人間が読みやすい形式で表示されます。

サンプルコードでは、まずDom\XMLDocumentのインスタンスを作成し、簡単なXML構造を構築しています。初期状態ではformatOutputはfalseが設定されており、この状態でsaveXML()を実行すると、XMLは改行やインデントなしの一行で出力されます。次に、$dom->formatOutput = true;と設定することで、プロパティの値をtrueに変更します。この後再度saveXML()を実行すると、XMLが構造に合わせて整形され、見やすい形で出力されることが確認できます。

formatOutputプロパティは、XMLの整形を行うかどうかを切り替えるためのものであり、その戻り値（プロパティの値を取得する際の型）は現在の設定状態を示すbool型です。trueであれば整形が有効、falseであれば無効です。この機能は、開発時やデバッグ時にXMLの内容を確認する際など、人間がXMLを読みやすくしたい場合に非常に役立ちます。最終的にfalseに戻すと、再び整形されずに一行で出力されることが示されています。

Copy
1<?php
2
3/**
4 * Dom\XMLDocument クラスの formatOutput プロパティの動作を示すサンプルコードです。
5 *
6 * formatOutput プロパティは、XML ドキュメントを出力する際に
7 * 人間が読みやすいように整形（インデントと改行）を行うかどうかを制御します。
8 * true に設定すると整形され、false に設定すると整形されません。
9 */
10
11// 1. Dom\XMLDocument オブジェクトを新しく作成します。
12//    これはXMLドキュメントを表すオブジェクトです。
13$xmlDocument = new Dom\XMLDocument();
14
15// 2. XMLドキュメントの基本的な構造を作成します。
16//    'root' という名前のルート要素を作成し、ドキュメントに追加します。
17$root = $xmlDocument->createElement('root');
18$xmlDocument->appendChild($root);
19
20// 3. ルート要素の子要素として 'item' を複数追加します。
21//    それぞれにテキストコンテンツを設定します。
22$item1 = $xmlDocument->createElement('item', '最初のデータ');
23$root->appendChild($item1);
24
25$item2 = $xmlDocument->createElement('item', '二番目のデータ');
26$root->appendChild($item2);
27
28$item3 = $xmlDocument->createElement('item', '三番目のデータ');
29$root->appendChild($item3);
30
31// 4. formatOutput プロパティを false に設定し、XMLを出力します。
32//    false の場合、XMLは整形されずに1行で出力される傾向があります。
33//    これは通常、ファイルサイズを小さくしたり、機械処理に適しています。
34echo "--- formatOutput が false の場合 (整形なし) ---\n";
35$xmlDocument->formatOutput = false; // 整形を無効にします
36echo $xmlDocument->saveXML();       // XMLドキュメントを文字列として取得し、出力します
37echo "\n\n";
38
39// 5. formatOutput プロパティを true に設定し、XMLを出力します。
40//    true の場合、XMLはインデントや改行が自動的に追加され、
41//    人間が読みやすい形式で出力されます。
42echo "--- formatOutput が true の場合 (整形あり) ---\n";
43$xmlDocument->formatOutput = true;  // 整形を有効にします
44echo $xmlDocument->saveXML();       // 整形されたXMLドキュメントを出力します
45echo "\n";

PHPのDom\XMLDocumentクラスのformatOutputプロパティは、XMLドキュメントを文字列として出力する際に、人間が読みやすいように自動整形（インデントや改行）を行うかどうかを制御するプロパティです。このプロパティはbool型の値を設定することで、XMLの整形を有効（true）または無効（false）に切り替えることができます。プロパティであるため、直接引数を受け取ることはありません。

サンプルコードでは、まず新しいDom\XMLDocumentオブジェクトを作成し、ルート要素と複数の子要素を持つ簡単なXML構造を構築しています。

次に、formatOutputプロパティをfalseに設定してsaveXML()メソッドでXMLを出力しています。この設定の場合、XMLはインデントや改行が適用されずに、通常は一行でコンパクトに表示されます。これは、ファイルサイズを小さくしたい場合や、プログラムによる機械的な処理に適しています。

その後、formatOutputプロパティをtrueに設定し直してXMLを出力すると、saveXML()によって出力されるXMLは、適切なインデントと改行が自動的に追加され、視覚的に構造が分かりやすい、人間にとって読みやすい形式となります。

このようにformatOutputプロパティを使用することで、XMLの出力形式を用途に応じて柔軟に切り替えることが可能です。