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

Copy
1<?php
2
3/**
4 * サンプルデータを元にXMLドキュメントを生成します。
5 * XMLWriter::endCdata メソッドと PHP の foreach...endforeach 構文の使用例を含みます。
6 *
7 * @param array<array<string>> $data XMLに含めるデータ配列。各要素は 'name' と 'description' キーを持つ連想配列である必要があります。
8 * @return string 生成されたXML文字列。
9 */
10function generateProductXml(array $data): string
11{
12    // XMLWriterインスタンスを作成
13    $writer = new XMLWriter();
14    // XMLをメモリバッファに書き込むように設定
15    $writer->openMemory();
16    // XMLドキュメントの宣言を開始 (バージョン1.0, エンコーディングUTF-8)
17    $writer->startDocument('1.0', 'UTF-8');
18    // 生成されるXMLの可読性を高めるためにインデントを有効にする
19    $writer->setIndent(true);
20    $writer->setIndentString('    '); // 4スペースでインデント
21
22    // ルート要素 'products' を開始
23    $writer->startElement('products');
24
25    // 提供されたデータ配列をループ処理
26    // 'foreach...endforeach;' 構文を使用しています。
27    foreach ($data as $index => $item):
28        // 各製品の要素 'product' を開始
29        $writer->startElement('product');
30        // 'id' 属性を追加
31        $writer->writeAttribute('id', (string)($index + 1));
32
33        // 'name' 要素を開始
34        $writer->startElement('name');
35        // CDATAセクションを開始
36        // CDATAセクション内のコンテンツはXMLパーサーによって解析されず、特殊文字がエスケープされずにそのまま扱われます。
37        $writer->startCdata();
38        // CDATAセクション内に製品名を書き込む
39        $writer->text($item['name']);
40        // CDATAセクションを終了 (XMLWriter::endCdata)
41        // 戻り値はbool型ですが、通常は成功を示すため、エラーハンドリングが必要な場合を除きチェックは稀です。
42        $writer->endCdata();
43        // 'name' 要素を終了
44        $writer->endElement(); // name
45
46        // 'description' 要素を開始
47        $writer->startElement('description');
48        // CDATAセクションを開始
49        $writer->startCdata();
50        // CDATAセクション内に製品の説明を書き込む
51        // HTMLタグやスクリプトタグが含まれていても、XMLエンティティとして扱われず、リテラルテキストとして保持されます。
52        $writer->text($item['description']);
53        // CDATAセクションを終了 (XMLWriter::endCdata)
54        $writer->endCdata();
55        // 'description' 要素を終了
56        $writer->endElement(); // description
57
58        // 'product' 要素を終了
59        $writer->endElement(); // product
60    // foreachループの終了
61    endforeach;
62
63    // ルート要素 'products' を終了
64    $writer->endElement(); // products
65
66    // XMLドキュメントの終了を宣言し、バッファの内容を確定
67    $writer->endDocument();
68
69    // メモリバッファに書き込まれたXML文字列を返す
70    return $writer->outputMemory();
71}
72
73// サンプルデータ配列
74$sampleProducts = [
75    [
76        'name' => 'Widget Pro Max',
77        'description' => 'This is a detailed description for Widget Pro Max. It includes special XML characters like < & > and even a potential script: <script>alert("XSS attempt!");</script>.'
78    ],
79    [
80        'name' => 'Gizmo Lite',
81        'description' => 'A compact device with advanced features. Review our website: <a href="http://example.com/gizmo">Gizmo Page</a> for more info.'
82    ]
83];
84
85// 関数を呼び出し、XML文字列を生成
86$generatedXml = generateProductXml($sampleProducts);
87
88// 生成されたXMLを出力
89echo $generatedXml;
90

このサンプルコードは、PHPのXMLWriterクラスを利用してXMLドキュメントを生成する方法を示しています。特に、XMLドキュメント内で特殊文字をエスケープせずに扱いたい場合に便利な「CDATAセクション」の記述方法と、PHPのループ構文であるforeach...endforeachの使用例を含んでいます。

XMLWriterクラスは、メモリやファイルに直接XMLを書き出すためのツールです。コードではopenMemory()でXMLをメモリに構築し、startDocument()でXML宣言を行い、startElement()とendElement()でXML要素を階層的に作成しています。

foreach ($data as $item): ... endforeach;という構文は、PHPで配列をループ処理する際に使われる、もう一つの記述形式です。通常のforeach { ... }と同じ機能を持つため、HTMLテンプレートなどで波括弧の代わりにコロンとendforeachでブロックを示す場合に利用されます。

本コードの主要なポイントはXMLWriter::endCdataメソッドです。XML内で<や&といった特殊文字を、XMLエンティティに変換せずにそのまま記述したい場合、startCdata()でCDATAセクションを開始し、その中にテキストを書き込んだ後、endCdata()でセクションを閉じます。endCdataメソッドは引数を必要とせず、現在開いているCDATAセクションを終了する役割を果たします。戻り値はbool型で、操作の成功・失敗を示しますが、通常は成功を期待するため、明示的に戻り値を確認することは稀です。CDATAセクション内のテキストはXMLパーサーによって解釈されず、データが安全にXMLドキュメントに組み込まれます。

このサンプルコードを通じて、複雑なデータをXML形式で構造化し、特殊なデータを含む場合でも適切に処理する方法を理解できます。

Copy
1<?php
2
3/**
4 * XMLWriter を使用してCDATAセクションを含むXMLドキュメントを生成するサンプル関数。
5 *
6 * この関数は、XMLWriter::startCdata() で開始されたCDATAセクションを
7 * XMLWriter::endCdata() で閉じる方法を示します。
8 * CDATAセクション内の内容は、XMLパーサーによって解析されずにそのまま保持されます。
9 *
10 * @return string 生成されたXML文字列
11 */
12function generateXmlWithCdata(): string
13{
14    // XMLWriter オブジェクトを初期化します。
15    // このオブジェクトを使ってXMLドキュメントを段階的に構築します。
16    $xmlWriter = new XMLWriter();
17
18    // 出力先をメモリに設定します。
19    // これにより、生成されたXMLはメモリ上に保持され、後で文字列として取得できます。
20    // ファイルに直接書き出す場合は、$xmlWriter->openURI('output.xml'); のようにします。
21    $xmlWriter->openMemory();
22
23    // XMLドキュメントの開始を宣言します。
24    // バージョンとエンコーディングを指定します。
25    $xmlWriter->startDocument('1.0', 'UTF-8');
26
27    // ルート要素 '<data>' を開始します。
28    $xmlWriter->startElement('data');
29
30    // 'item' 要素を開始し、属性を追加します。
31    $xmlWriter->startElement('item');
32    $xmlWriter->writeAttribute('id', 'unique-id-123');
33
34    // CDATAセクションを開始します。
35    // CDATAセクション内のテキストはXMLの特殊文字（<, >, &, "など）がエスケープされずに
36    // そのままの内容でXMLドキュメントに含められます。
37    // これは、HTMLコードやスクリプト、XMLフラグメントなどをXML内に埋め込む際に便利です。
38    $xmlWriter->startCdata();
39
40    // CDATAセクションに生データを書き込みます。
41    // ここに含まれる '<script>' タグはエスケープされません。
42    $xmlWriter->writeRaw('<script>alert("Hello from CDATA!");</script>');
43
44    // CDATAセクションを終了します。
45    // これが今回のキーとなるメソッドです。
46    // startCdata() で開かれたセクションを閉じます。
47    $xmlWriter->endCdata();
48
49    // 'item' 要素を終了します。
50    $xmlWriter->endElement();
51
52    // 通常のテキストを含む別の要素を追加します（比較のため）。
53    // writeElement() は要素の開始、テキストの書き込み、要素の終了を一度に行います。
54    // 通常のテキストは、特殊文字が自動的にエスケープされます。
55    $xmlWriter->writeElement('message', 'This is <regular> text with special & characters.');
56
57    // ルート要素 '<data>' を終了します。
58    $xmlWriter->endElement();
59
60    // XMLドキュメントの終了を宣言します。
61    $xmlWriter->endDocument();
62
63    // メモリ上に構築されたXMLドキュメントを文字列として取得し、返します。
64    return $xmlWriter->flush();
65}
66
67// 関数を実行し、生成されたXML文字列を出力します。
68echo generateXmlWithCdata();

XMLWriter::endCdata()は、PHPのXMLWriterクラスに属するメソッドで、XMLドキュメント内で開始されたCDATAセクションを終了する際に使用します。CDATAセクションとは、XMLパーサーがその中のテキストをマークアップとして解析せず、そのままのテキストデータとして扱う特別な領域のことです。これは、HTMLコードやスクリプトタグ、XMLの特殊文字を多く含むテキストなどをXML内に埋め込みたい場合に特に役立ちます。

サンプルコードでは、まずXMLWriterオブジェクトを初期化し、XMLドキュメントの作成を開始しています。<data>要素と<item>要素を定義した後、XMLWriter::startCdata()メソッドを呼び出すことでCDATAセクションが開始されます。このセクション内にXMLWriter::writeRaw()で書き込まれた<script>alert("Hello from CDATA!");</script>のような内容は、XMLの特殊文字がエスケープされることなく、生のデータとして扱われます。

そして、今回のキーとなるXMLWriter::endCdata()メソッドは、引数なしで呼び出され、この開始されたCDATAセクションを閉じます。このメソッドがtrueを返せばCDATAセクションの終了は成功し、falseが返されれば失敗したことになりますが、通常は成功します。XMLWriter::endCdata()は、XMLの構造を正しく保つために、XMLWriter::startCdata()と必ず対で使用される重要なメソッドです。