【PHP8.x】xmlwriter_set_indent()関数の使い方

Copy
1<?php
2
3/**
4 * XMLWriter を使用してインデントされた XML を生成するサンプルです。
5 * xmlwriter_set_indent 関数で出力のインデントを有効にします。
6 */
7
8// XMLWriter オブジェクトをメモリ上で初期化します。
9$writer = xmlwriter_open_memory();
10
11// XML の出力にインデントを有効にします。
12// これを false に設定すると、XML は改行なしの1行で出力されます。
13xmlwriter_set_indent($writer, true);
14
15// インデントに使用する文字列を設定します。（例: スペース2つ）
16// この設定は xmlwriter_set_indent が true の場合にのみ効果があります。
17xmlwriter_set_indent_string($writer, '  ');
18
19// XML ドキュメントを開始します。バージョンとエンコーディングを指定します。
20xmlwriter_start_document($writer, '1.0', 'UTF-8');
21
22// ルート要素 'books' を開始します。
23xmlwriter_start_element($writer, 'books');
24
25    // 'book' 要素を開始し、属性 'id' を追加します。
26    xmlwriter_start_element($writer, 'book');
27        xmlwriter_write_attribute($writer, 'id', 'B001');
28
29        // 'title' 要素と内容を追加します。
30        xmlwriter_start_element($writer, 'title');
31            xmlwriter_write_raw($writer, 'PHP入門');
32        xmlwriter_end_element($writer); // title
33
34        // 'author' 要素と内容を追加します。
35        xmlwriter_start_element($writer, 'author');
36            xmlwriter_write_raw($writer, '山田太郎');
37        xmlwriter_end_element($writer); // author
38
39    xmlwriter_end_element($writer); // book
40
41    // 別の 'book' 要素を追加します。
42    xmlwriter_start_element($writer, 'book');
43        xmlwriter_write_attribute($writer, 'id', 'B002');
44
45        xmlwriter_start_element($writer, 'title');
46            xmlwriter_write_raw($writer, 'XMLの基礎');
47        xmlwriter_end_element($writer); // title
48
49        xmlwriter_start_element($writer, 'author');
50            xmlwriter_write_raw($writer, '鈴木花子');
51        xmlwriter_end_element($writer); // author
52
53    xmlwriter_end_element($writer); // book
54
55xmlwriter_end_element($writer); // books
56
57// XML ドキュメントを終了します。
58xmlwriter_end_document($writer);
59
60// 生成された XML を取得して出力します。
61echo xmlwriter_output_memory($writer);
62
63?>

このサンプルコードは、PHPのXMLWriter拡張機能を利用して、読みやすいようにインデントされたXMLデータを生成する方法を示しています。まず、xmlwriter_open_memory()関数でXMLWriterオブジェクトをメモリ上に作成し、XMLの構築準備をします。

コードの重要な部分はxmlwriter_set_indent関数です。この関数は、XML出力にインデント（字下げ）を適用するかどうかを設定するために使用されます。第1引数には、操作対象となるXMLWriterオブジェクトを指定します。第2引数$enableには、インデントを有効にする場合はtrueを、無効にする場合はfalseを設定します。falseを指定した場合、XMLは改行されずに1行で出力されます。この関数は、設定が成功したかどうかを真偽値（trueまたはfalse）で返します。

サンプルコードでは、xmlwriter_set_indent($writer, true)でインデントを有効にした後、xmlwriter_set_indent_string($writer, ' ')でインデントにスペース2つを使用するよう設定しています。xmlwriter_set_indent_string関数は、xmlwriter_set_indentによってインデントが有効になっている場合にのみ機能します。

その後、xmlwriter_start_documentでXMLドキュメントを開始し、xmlwriter_start_elementやxmlwriter_write_attribute、xmlwriter_write_rawなどの関数を使い、階層的なXML構造を順に構築しています。すべてのXML要素の定義が完了したら、xmlwriter_end_document()でドキュメントを閉じ、最後にxmlwriter_output_memory($writer)によって生成された整形済みのXML文字列を取得し、出力しています。このように、XMLWriterはプログラムから構造化されたXMLを効率的に生成する際に役立ちます。

Copy
1<?php
2
3/**
4 * XMLWriterエクステンションを使って、インデントされたXMLを生成するサンプルコードです。
5 *
6 * XMLWriterはPHPに標準で含まれるエクステンションですが、
7 * 環境によっては php.ini で 'extension=xmlwriter' を有効にする必要がある場合があります。
8 * 通常、PHPをインストールする際に自動的に有効になっています。
9 */
10
11// 1. XMLWriterオブジェクトをメモリ上に作成します。
12//    これにより、生成されるXMLはメモリバッファに書き込まれます。
13$writer = xmlwriter_open_memory();
14
15// 2. xmlwriter_set_indent() を使用して、XML出力にインデントと改行を有効にします。
16//    これにより、生成されるXMLが整形され、人間にとって読みやすくなります。
17//    引数: XMLWriterオブジェクト、インデントを有効にするかどうかの真偽値 (trueで有効)
18if (xmlwriter_set_indent($writer, true)) {
19    // 3. 必要に応じて、インデントに使用する文字列を設定することもできます。
20    //    デフォルトはスペース4つです。今回はデフォルトを使用するため、この行はコメントアウト。
21    // xmlwriter_set_indent_string($writer, '    '); // 例: スペース4つ
22
23    // 4. XMLドキュメントの開始を宣言します。（バージョン1.0、文字コードUTF-8）
24    xmlwriter_start_document('1.0', 'UTF-8');
25
26    // 5. ルート要素 'products' を開始します。
27    xmlwriter_start_element('products');
28
29    // 6. 最初の 'product' 要素とその子要素、属性を作成します。
30    xmlwriter_start_element('product');
31    xmlwriter_write_attribute('id', '101');
32    xmlwriter_write_element('name', '高性能スマートフォン');
33    xmlwriter_write_element('price', '89900');
34    xmlwriter_write_element('currency', 'JPY');
35    xmlwriter_end_element(); // 'product' 要素を終了
36
37    // 7. 2番目の 'product' 要素を作成します。
38    xmlwriter_start_element('product');
39    xmlwriter_write_attribute('id', '102');
40    xmlwriter_write_element('name', '軽量ノートPC');
41    xmlwriter_write_element('price', '125000');
42    xmlwriter_write_element('currency', 'JPY');
43    xmlwriter_end_element(); // 'product' 要素を終了
44
45    xmlwriter_end_element(); // ルート要素 'products' を終了
46    xmlwriter_end_document(); // XMLドキュメントの終了を宣言
47
48    // 8. 生成されたXMLをメモリバッファから取得し、出力します。
49    //    xmlwriter_flush() の第2引数を true にすると、バッファの内容をクリアせずに取得します。
50    echo xmlwriter_flush($writer, true);
51
52} else {
53    // インデント設定が失敗した場合のエラーメッセージ
54    echo "XMLWriterのインデント設定に失敗しました。\n";
55}
56
57?>

このサンプルコードは、PHPのXMLWriterエクステンションを利用して、自動的にインデント（字下げ）された、人間にとって読みやすいXMLドキュメントを生成する方法を示しています。XMLWriterはPHPに標準で含まれる機能であり、効率的にXMLを作成する際に使用されますが、環境によってはphp.iniファイルでextension=xmlwriterを有効にする必要がある場合があります。

中心となるxmlwriter_set_indent()関数は、XMLWriterオブジェクトが生成するXML出力に対して、インデントと改行を自動的に適用するために使われます。この関数の第一引数には、操作対象となるXMLWriterオブジェクトを指定します。第二引数には、インデント機能を有効にするかどうかを真偽値で指定し、trueを渡すとインデントが有効になり、falseで無効になります。関数は、設定が成功した場合はtrueを、失敗した場合はfalseを返します。

コードでは、まずxmlwriter_open_memory()でXMLWriterオブジェクトをメモリ上に作成し、そのオブジェクトに対してxmlwriter_set_indent($writer, true)を呼び出してインデントを有効にしています。その後、xmlwriter_start_document()でXML宣言を書き始め、xmlwriter_start_element()やxmlwriter_write_element()などの関数を使ってXMLの要素や属性を順に構築していきます。最終的にxmlwriter_flush($writer, true)で、メモリバッファに書き込まれた完成した整形済みXML文字列を取得し、画面に出力しています。このようにインデントを適用することで、XMLの階層構造が視覚的に明確になり、デバッグや内容の確認が容易になります。