【PHP8.x】xmlwriter_write_attribute関数の使い方

Copy
1<?php
2
3/**
4 * XMLWriter を使用して属性を持つ要素を生成するサンプルコードです。
5 * `xmlwriter_write_attribute` 関数は、現在開かれている要素に属性を追加します。
6 */
7
8// 1. XMLWriter オブジェクトを作成し、XML をメモリに書き込むよう設定します。
9$writer = xmlwriter_open_memory();
10
11// 2. XML ドキュメントの開始を宣言します（XML 宣言: <?xml version="1.0" encoding="UTF-8"?>）。
12xmlwriter_start_document($writer, '1.0', 'UTF-8');
13
14// 3. ルート要素 'products' を開始します。
15xmlwriter_start_element($writer, 'products');
16
17    // 4. 子要素 'item' を開始します。
18    xmlwriter_start_element($writer, 'item');
19
20        // 5. 'item' 要素に 'id' 属性を追加します。
21        //    引数: (XMLWriter オブジェクト, 属性名, 属性値)
22        xmlwriter_write_attribute($writer, 'id', 'SKU001');
23
24        // 6. 'item' 要素に 'category' 属性を追加します。
25        xmlwriter_write_attribute($writer, 'category', 'Electronics');
26
27        // 7. 'item' 要素の内容を追加します。
28        xmlwriter_text($writer, 'スマートフォン');
29
30    // 8. 'item' 要素を閉じます（</item>）。
31    xmlwriter_end_element($writer);
32
33    // 別の 'item' 要素を追加する例
34    xmlwriter_start_element($writer, 'item');
35    xmlwriter_write_attribute($writer, 'id', 'SKU002');
36    xmlwriter_write_attribute($writer, 'category', 'Books');
37    xmlwriter_text($writer, 'プログラミング入門');
38    xmlwriter_end_element($writer);
39
40// 9. ルート要素 'products' を閉じます（</products>）。
41xmlwriter_end_element($writer);
42
43// 10. XML ドキュメントの終了を宣言します。
44xmlwriter_end_document($writer);
45
46// 11. 作成された XML 文字列をメモリから取得し、出力します。
47echo xmlwriter_output_memory($writer);
48
49?>

このサンプルコードは、PHPのXMLWriterという機能を使って、属性を持つXML要素を効率的に生成する方法を示しています。まずxmlwriter_open_memory()でXMLWriterオブジェクトを作成し、XMLデータをメモリ上で構築する準備をします。xmlwriter_start_document()とxmlwriter_end_document()でXMLドキュメント全体の開始と終了を宣言し、xmlwriter_start_element()とxmlwriter_end_element()でXMLの要素（タグ）を一つずつ作成していきます。

特に重要なのはxmlwriter_write_attribute関数です。この関数は、現在xmlwriter_start_element()で開かれている要素に対して属性を追加する際に使用されます。第1引数にはXMLを書き込むXMLWriterオブジェクト、第2引数には追加したい属性の名前（例: 'id'）、そして第3引数にはその属性の値（例: 'SKU001'）を指定します。この関数は、属性の書き込みが成功すればtrue、失敗すればfalseをbool型で返します。要素内のテキスト内容はxmlwriter_text()で追加します。全てのXML構造を構築した後、xmlwriter_output_memory()でメモリ上に作成された最終的なXML文字列を取得し、画面に出力しています。このように、プログラムから動的に属性付きのXMLデータを簡単に生成できます。