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

Copy
1<?php
2
3/**
4 * xmlwriter_flush 関数の使用方法を示すサンプルコード。
5 *
6 * xmlwriter_flush は、XMLWriter のバッファの内容をフラッシュし、
7 * それを文字列として返す（メモリモードの場合）。
8 * 第2引数 $empty が true の場合、フラッシュ後にバッファはクリアされます。
9 */
10function generateXmlWithFlush(): void
11{
12    // 1. XMLWriter インスタンスをメモリモードで作成
13    //    xmlwriter_open_memory() は、XML をメモリバッファに書き込むためのライターを作成します。
14    $writer = xmlwriter_open_memory();
15
16    // 2. 出力されるXMLを整形するための設定（任意だが推奨される）
17    //    xmlwriter_set_indent(true) でインデントを有効にします。
18    xmlwriter_set_indent($writer, true);
19    //    xmlwriter_set_indent_string() でインデントに使用する文字列を設定します。
20    xmlwriter_set_indent_string($writer, '  '); // スペース2つでインデント
21
22    // 3. XMLドキュメントの開始
23    //    xmlwriter_start_document(バージョン, エンコーディング)
24    xmlwriter_start_document($writer, '1.0', 'UTF-8');
25
26    // 4. ルート要素の開始
27    xmlwriter_start_element($writer, 'data');
28
29    // 5. 最初の子要素を追加
30    xmlwriter_start_element($writer, 'item');
31    xmlwriter_write_attribute($writer, 'id', '1');
32    xmlwriter_write_element($writer, 'name', '最初のアイテム');
33    xmlwriter_end_element($writer); // 'item'要素を閉じる
34
35    // 6. ここで xmlwriter_flush を使用して、現在のバッファ内容を取得し、クリアします。
36    //    第2引数 $empty が true なので、バッファ内容は返された後、クリアされます。
37    echo "--- 最初のフラッシュで取得されたXML (バッファはクリアされます) ---\n";
38    $firstFlushContent = xmlwriter_flush($writer, true);
39    echo $firstFlushContent;
40    echo "---------------------------------------------------\n\n";
41
42    // 7. バッファがクリアされたので、さらに要素を追加
43    //    これらの要素は、前のフラッシュで取得した内容には含まれていません。
44    xmlwriter_start_element($writer, 'item');
45    xmlwriter_write_attribute($writer, 'id', '2');
46    xmlwriter_write_element($writer, 'name', '二番目のアイテム');
47    xmlwriter_end_element($writer); // 'item'要素を閉じる
48
49    // 8. ルート要素とドキュメントを閉じる
50    xmlwriter_end_element($writer); // 'data'要素を閉じる
51    xmlwriter_end_document($writer);
52
53    // 9. 最終的な内容をフラッシュして取得（再度バッファをクリア）
54    //    第2引数 $empty が true なので、この時点までの残りのバッファ内容が返されます。
55    echo "--- 2回目のフラッシュで取得されたXML (残りの内容、バッファはクリアされます) ---\n";
56    $secondFlushContent = xmlwriter_flush($writer, true);
57    echo $secondFlushContent;
58    echo "---------------------------------------------------\n";
59
60    // 注意:
61    // xmlwriter_flush は、特に大きなXMLを生成する際に、部分的に出力してメモリを節約したり、
62    // 進行状況を表示したりするのに役立ちます。
63    // 完全なXMLドキュメントを一度に取得する場合は、
64    // すべての要素を閉じ終えた後で xmlwriter_output_memory($writer, true) を使うことも一般的です。
65}
66
67// 関数を実行して、XML生成とフラッシュの動作を確認
68generateXmlWithFlush();

PHPのxmlwriter_flush関数は、XMLWriter拡張機能で使用され、現在バッファに格納されているXMLデータを処理するために利用されます。この関数は、xmlwriter_open_memory()で作成されたメモリモードのXMLWriterインスタンスの場合、バッファの内容を文字列として取得し、xmlwriter_open_uri()で作成されたファイルモードのインスタンスの場合、バッファの内容をファイルに書き込みます。

第一引数$writerには、操作対象となるXMLWriterインスタンスを指定します。第二引数$emptyはオプションで、デフォルトはtrueです。trueを指定すると、フラッシュ後にXMLWriterの内部バッファがクリアされます。falseを指定すると、バッファの内容はクリアされずに保持されます。

戻り値は、メモリモードではフラッシュされたXMLデータがstringとして返され、ファイルモードでは書き込まれたバイト数がintとして返されます。

サンプルコードでは、メモリモードでXMLを生成する途中にxmlwriter_flushを呼び出し、trueを渡すことで、そこまでのXML内容を取得しつつバッファをクリアしています。これにより、例えば非常に大きなXMLドキュメントを生成する際に、一度にすべての内容をメモリに保持せず、部分的に処理したり、途中の進捗を確認したりすることが可能になります。フラッシュ後にバッファがクリアされるため、続けてXMLを追加しても、以前フラッシュした内容には影響しません。すべてのXML要素を書き終えた後に最終的な内容を取得したい場合は、xmlwriter_output_memory()関数を使用することも一般的です。