【PHP8.x】XMLWriter::endElement()メソッドの使い方

Copy
1<?php
2
3/**
4 * 商品データの配列からXML文字列を生成する関数。
5 * XMLWriter::endElementを使用して、開いたXML要素を正しく閉じます。
6 *
7 * @param array $products XMLに変換する商品データの配列。
8 *                         各商品は 'id', 'name', 'description' のキーを持つ連想配列であると仮定します。
9 * @return string 生成されたXML文字列。
10 */
11function generateProductsXml(array $products): string
12{
13    // XMLWriterオブジェクトを初期化
14    $xmlWriter = new XMLWriter();
15
16    // 出力先をメモリに設定し、XMLを整形して出力するように設定します。
17    // openMemory()がfalseを返した場合はエラーですが、このサンプルでは省略しています。
18    $xmlWriter->openMemory();
19    $xmlWriter->setIndent(true);         // XMLを読みやすくするためにインデントを有効にします。
20    $xmlWriter->setIndentString('    '); // インデントにスペース4つを使用します。
21
22    // XMLドキュメントの開始を宣言します。バージョン1.0、エンコーディングUTF-8。
23    $xmlWriter->startDocument('1.0', 'UTF-8');
24
25    // ルート要素 <products> を開始します。
26    $xmlWriter->startElement('products');
27
28    // 引数で受け取った商品データの配列をループ処理します。
29    // キーワード「php endforeach」に示唆されるループ処理の文脈でXML要素を生成します。
30    foreach ($products as $product) {
31        // 各商品に対して <product> 要素を開始します。
32        $xmlWriter->startElement('product');
33        // <product> 要素に 'id' 属性を追加します。
34        $xmlWriter->writeAttribute('id', $product['id']);
35
36        // <name> 要素を開始し、その内容を書き込みます。
37        $xmlWriter->startElement('name');
38        $xmlWriter->writeCData($product['name']); // CDATAセクションとして書き込むことで、特殊文字がエスケープされません。
39        // <name> 要素を閉じます。
40        // これは XMLWriter::startElement('name') に対応します。
41        $xmlWriter->endElement();
42
43        // <description> 要素を開始し、その内容を書き込みます。
44        $xmlWriter->startElement('description');
45        $xmlWriter->writeCData($product['description']);
46        // <description> 要素を閉じます。
47        // これは XMLWriter::startElement('description') に対応します。
48        $xmlWriter->endElement();
49
50        // <product> 要素を閉じます。
51        // これは XMLWriter::startElement('product') に対応します。
52        // XMLWriter::endElementは、最後に開かれた要素を閉じます。
53        $xmlWriter->endElement();
54    }
55
56    // ルート要素 <products> を閉じます。
57    // これは XMLWriter::startElement('products') に対応します。
58    $xmlWriter->endElement();
59
60    // XMLドキュメントの終了を宣言します。
61    $xmlWriter->endDocument();
62
63    // 生成されたXML文字列を返します。
64    return $xmlWriter->flush();
65}
66
67// サンプル商品データの配列
68$sampleProducts = [
69    ['id' => 101, 'name' => 'スマートウォッチ', 'description' => '最新のフィットネス追跡機能と通知機能を備えたウェアラブルデバイス。'],
70    ['id' => 102, 'name' => 'ワイヤレスイヤホン', 'description' => '高音質で長時間の再生が可能なBluetoothイヤホン。ノイズキャンセリング機能付き。'],
71    ['id' => 103, 'name' => 'ポータブル充電器', 'description' => '外出先でも安心の大容量モバイルバッテリー。高速充電対応。'],
72];
73
74// 関数を呼び出してXML文字列を生成し、出力します。
75$xmlString = generateProductsXml($sampleProducts);
76echo $xmlString;
77
78?>

PHP 8のXMLWriter::endElementメソッドは、XML文書を段階的に作成する際に開いたXML要素を閉じるために使用されます。このメソッドはXMLWriterクラスに属し、startElementメソッドで開始した要素に対応する終了タグを書き出す役割を担います。

endElementメソッドは引数を一切必要としません。呼び出されると、最後にstartElementで開かれたXML要素を自動的に閉じます。メソッドの実行が成功した場合はtrueを、何らかの理由で失敗した場合はfalseをブール値として返します。

サンプルコードでは、例えば<name>要素や<description>要素のように、startElement('name')で開始した後に内容を書き込み、直後に$xmlWriter->endElement();を呼び出して要素を閉じています。これにより、<name>...</name>といった整形式のXML構造が確実に生成されます。foreachループ内で複数の商品データを処理する際にも、個々の<product>要素やその子要素が開始・終了のペアで適切に閉じられ、XML文書の構造が正しく保たれています。endElementはstartElementとセットで使い、XMLの階層構造を正確に構築するために不可欠なメソッドです。

Copy
1<?php
2
3/**
4 * XMLWriter を使用して、アイテムリストのXMLを生成します。
5 *
6 * この関数は、XMLWriter::endElement() メソッドの基本的な使い方を示すとともに、
7 * PHPの while...endwhile; 制御構造の例も示します。
8 * XMLWriter::endElement() は、現在開いている要素を閉じます。
9 *
10 * @return string 生成されたXML文字列
11 */
12function generateItemListXml(): string
13{
14    // XMLWriterオブジェクトを初期化します。
15    // openMemory() を使用して、XMLをメモリバッファに書き込みます。
16    $writer = new XMLWriter();
17    $writer->openMemory();
18
19    // XMLの出力を見やすくするためにインデントを有効にします。
20    $writer->setIndent(true);
21    $writer->setIndentString('  '); // インデントにスペース2つを使用
22
23    // XMLドキュメントの開始を宣言します。
24    // バージョン1.0、エンコーディングUTF-8。
25    $writer->startDocument('1.0', 'UTF-8');
26
27    // ルート要素 <items> を開始します。
28    $writer->startElement('items');
29
30    $itemCount = 0;
31    // PHPの while ループの代替構文である while...endwhile; を使用して、
32    // 複数の <item> 要素を生成します。
33    // これはXMLWriterの機能ではなく、PHPの制御構造の例です。
34    while ($itemCount < 3):
35        // 各アイテムの <item> 要素を開始します。
36        $writer->startElement('item');
37        $writer->writeAttribute('id', $itemCount + 1); // id属性を追加
38
39        // <name> と <value> 子要素を追加します。
40        $writer->writeElement('name', 'Product ' . ($itemCount + 1));
41        $writer->writeElement('value', ($itemCount + 1) * 100);
42
43        // 現在開いている <item> 要素を終了します。
44        // XMLWriter::endElement() は引数なしで呼び出され、
45        // 直前の startElement() で開かれた要素 (この場合は <item>) を閉じます。
46        // 戻り値は成功時に true、失敗時に false ですが、通常は確認しません。
47        $writer->endElement(); // </item> タグを書き込む
48
49        $itemCount++;
50    endwhile; // while ループの終了
51
52    // ルート要素 <items> を終了します。
53    $writer->endElement(); // </items> タグを書き込む
54
55    // XMLドキュメントの終了を宣言します。
56    $writer->endDocument();
57
58    // メモリバッファに書き込まれたXML文字列を取得します。
59    return $writer->outputMemory();
60}
61
62// 関数を呼び出し、生成されたXMLを標準出力に出力します。
63echo generateItemListXml();

PHP 8のXMLWriterクラスに属するendElementメソッドは、XML文書の要素を閉じるために使用される重要な機能です。このメソッドは引数を受け取らず、直前にstartElementメソッドで開かれた要素の終了タグを書き込みます。例えば、<element_name>という要素を開始した場合、endElement()を呼び出すことで</element_name>が生成されます。

メソッドの戻り値はbool型で、要素の終了処理が成功すればtrueを、失敗すればfalseを返します。通常、XML書き込みが正常に進む環境ではtrueが返されるため、多くの場合は戻り値を確認する必要はありません。

提供されたサンプルコードでは、XMLWriterオブジェクトを用いてXMLを生成しています。まずstartElement('items')でルート要素<items>を開始し、その中にwhile...endwhile;ループを使用して複数の<item>要素を作成しています。while...endwhile;はPHPの別の制御構造の構文ですが、その中で各<item>要素がstartElement('item')で開始された後、子要素が書き込まれ、最後に$writer->endElement();が呼び出されることで、個々の<item>要素が正しく閉じられています。ループが終了した後も、$writer->endElement();を再度呼び出すことで、最初に開いたルート要素<items>も適切に閉じられ、整形式なXML構造が完成します。このようにendElementは、開いた要素を順番に閉じることで、正しいXML文書を構築するために不可欠な役割を果たします。