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

Copy
1<?php
2
3/**
4 * XMLWriter を使用してDTD要素定義を含むXMLを生成する関数。
5 * DTD要素の定義情報を配列から取得し、XMLWriterのメソッドでXMLを構築します。
6 *
7 * @return string 生成されたXML文字列
8 */
9function generateXmlWithDtdElementsFromArr(): string
10{
11    // XMLWriter オブジェクトを作成
12    $xml = new XMLWriter();
13    // メモリにXMLを書き込むように設定
14    $xml->openMemory();
15    // 整形された出力にする
16    $xml->setIndent(true);
17    // インデントにスペース4つを使用
18    $xml->setIndentString('    ');
19
20    // XML ドキュメントの開始 (XML 宣言)
21    // DTD は startDtd メソッドで別途定義します。
22    $xml->startDocument('1.0', 'UTF-8');
23
24    // DTD (Document Type Definition) の開始
25    // ここでXML文書のルート要素名 "bookstore" を指定します。
26    $xml->startDtd('bookstore');
27
28    // DTD要素の定義情報を連想配列で準備します。
29    // キーは要素名、値はその要素の内容モデル（DTDの構文）。
30    $dtdElementDefinitions = [
31        'bookstore' => '(book+)', // 'bookstore'は'book'要素が1回以上出現
32        'book'      => '(title, author, year, price)', // 'book'は子要素'title', 'author', 'year', 'price'を持つ
33        'title'     => '(#PCDATA)', // 'title'はパース済み文字データ
34        'author'    => '(#PCDATA)',
35        'year'      => '(#PCDATA)',
36        'price'     => '(#PCDATA)',
37    ];
38
39    // 配列の各定義を使ってDTD要素を生成します。
40    // これにより、「配列」からDTD情報を取得し、「end」メソッドで定義を閉じます。
41    foreach ($dtdElementDefinitions as $elementName => $contentModel) {
42        // 新しいDTD要素の定義を開始
43        // 例: <!ELEMENT bookstore (book+)> の <!ELEMENT bookstore の部分
44        $xml->startDtdElement($elementName);
45
46        // 要素の内容モデルを書き込む（DTDの構文をそのまま書き込むため writeRaw を使用）
47        // 例: (book+) の部分
48        $xml->writeRaw($contentModel);
49
50        // 現在のDTD要素の定義を終了します。
51        // startDtdElement() で開かれた要素定義を閉じます。
52        $xml->endDtdElement();
53    }
54
55    // DTD定義の終了
56    $xml->endDtd();
57
58    // DTDで定義された構造に沿って実際のXML要素を書き込みます。
59    $xml->startElement('bookstore');
60        $xml->startElement('book');
61            $xml->writeElement('title', 'PHPで学ぶプログラミング');
62            $xml->writeElement('author', '山田太郎');
63            $xml->writeElement('year', '2023');
64            $xml->writeElement('price', '29.99');
65        $xml->endElement(); // book要素の終了
66        $xml->startElement('book');
67            $xml->writeElement('title', '実践！Webシステム開発');
68            $xml->writeElement('author', '佐藤花子');
69            $xml->writeElement('year', '2022');
70            $xml->writeElement('price', '39.99');
71        $xml->endElement(); // book要素の終了
72    $xml->endElement(); // bookstore要素の終了
73
74    // XML ドキュメントの終了
75    $xml->endDocument();
76
77    // 生成されたXML文字列を取得して返します。
78    return $xml->outputMemory();
79}
80
81// 関数を実行し、生成されたXMLを出力します。
82echo generateXmlWithDtdElementsFromArr();

PHPのXMLWriter::endDtdElementメソッドは、XML文書のDTD（Document Type Definition）内で、特定の要素の定義を終了するために使用されます。これはstartDtdElementメソッドで開始された要素定義のスコープを閉じ、定義の整合性を確保する重要な役割を果たします。HTMLタグの開始タグと終了タグが対になるように、DTD要素の定義においても開始と終了を明示的に指定する必要があります。

サンプルコードでは、$dtdElementDefinitionsという連想配列に各DTD要素の名前とその内容モデル（構造）が定義されています。この配列をforeachループで処理し、各要素に対してstartDtdElementで定義を開始した後、writeRawで内容モデルを書き込み、最後にendDtdElementを呼び出すことで、その要素の定義を完了させています。これにより、配列から動的にDTD要素定義を生成し、「end」メソッドで正しく閉じることができます。

このメソッドは引数を必要としません。処理が成功した場合にはtrueを、失敗した場合にはfalseをブール値として返します。XMLWriterクラスとendDtdElementを組み合わせることで、PHPプログラム内でDTD要素定義を含むXML文書を、配列などのデータソースから効率的かつ正確に構築することが可能となります。

Copy
1<?php
2
3/**
4 * XMLWriter を使用して DTD (文書型定義) と XML 文書を生成するサンプル関数。
5 *
6 * この関数は、XMLWriter を用いて DTD を含む XML をメモリ上に構築し、
7 * XMLWriter::endDtdElement メソッドの利用例を示します。
8 * また、PHPの連想配列から XML 要素を生成する一般的な方法も組み込んでいます。
9 *
10 * @return string 生成された XML 文書
11 */
12function generateXmlWithDtdAndData(): string
13{
14    $xmlWriter = new XMLWriter();
15    $xmlWriter->openMemory(); // XML をメモリに出力するよう設定
16    $xmlWriter->setIndent(true); // 出力XMLを整形（インデント）
17    $xmlWriter->setIndentString('    '); // インデントに使う文字列を指定
18
19    // XML 宣言の開始
20    $xmlWriter->startDocument('1.0', 'UTF-8');
21
22    // DTD (Document Type Definition) 宣言の開始
23    // ルート要素が 'root' であることを定義します。
24    // 例: <!DOCTYPE root>
25    $xmlWriter->startDtd('root');
26
27    // DTD 要素 'item' の定義開始
28    // 例: <!ELEMENT item (#PCDATA)>
29    // (#PCDATA は "Parsed Character Data" の略で、解析済み文字データを意味します)
30    $xmlWriter->startDtdElement('item');
31    $xmlWriter->writeDtdPcdata('#PCDATA');
32    // DTD 要素 'item' の定義終了
33    $xmlWriter->endDtdElement(); // XMLWriter::endDtdElement の利用例
34
35    // DTD 要素 'items' の定義開始
36    // 例: <!ELEMENT items (item*)>
37    // (item* は 'item' 要素が0回以上出現することを意味します)
38    $xmlWriter->startDtdElement('items');
39    $xmlWriter->writeDtdElement('item', '*');
40    // DTD 要素 'items' の定義終了
41    $xmlWriter->endDtdElement(); // 別の XMLWriter::endDtdElement の利用例
42
43    // DTD 要素 'root' の定義開始
44    // 例: <!ELEMENT root (items)>
45    // (items は 'items' 要素を一つ含むことを意味します)
46    $xmlWriter->startDtdElement('root');
47    $xmlWriter->writeDtdElement('items');
48    // DTD 要素 'root' の定義終了
49    $xmlWriter->endDtdElement(); // 最後の XMLWriter::endDtdElement の利用例
50
51    // DTD 宣言の終了
52    $xmlWriter->endDtd();
53
54    // ここから実際の XML 文書の内容を生成します。
55    // PHP の連想配列を使用してデータを表現し、XML に変換します。
56    $products = [
57        ['id' => 101, 'name' => 'Laptop', 'price' => 120000],
58        ['id' => 102, 'name' => 'Mouse', 'price' => 2500],
59        ['id' => 103, 'name' => 'Keyboard', 'price' => 7000],
60    ];
61
62    // ルート要素 'root' の開始
63    $xmlWriter->startElement('root');
64        // 'items' 要素の開始
65        $xmlWriter->startElement('items');
66            // 連想配列の各要素を 'item' XML要素として書き出す
67            foreach ($products as $product) {
68                // 'item' 要素の開始
69                $xmlWriter->startElement('item');
70                    // 'id' を属性として追加
71                    $xmlWriter->writeAttribute('id', $product['id']);
72                    // 'name' を子要素として追加
73                    $xmlWriter->writeElement('name', $product['name']);
74                    // 'price' を子要素として追加
75                    $xmlWriter->writeElement('price', $product['price']);
76                // 'item' 要素の終了
77                $xmlWriter->endElement();
78            }
79        // 'items' 要素の終了
80        $xmlWriter->endElement();
81    // ルート要素 'root' の終了
82    $xmlWriter->endElement();
83
84    // XML 文書の終了
85    $xmlWriter->endDocument();
86
87    // 生成された XML 文字列を取得して返す
88    return $xmlWriter->flush();
89}
90
91// 関数を実行し、生成された XML を出力します。
92echo generateXmlWithDtdAndData();

PHPのXMLWriter::endDtdElementメソッドは、XML文書の構造を定義するDTD（文書型定義）を作成する際に、特定のDTD要素の定義を終了するために使用されます。このメソッドは、XMLWriter::startDtdElementで開始した要素定義のスコープを閉じ、DTDの階層構造を正しく記述するために不可欠です。引数は不要で、処理が成功した場合は真（true）、失敗した場合は偽（false）をブール値で返します。

サンプルコードでは、まずXMLWriterオブジェクトを初期化し、XMLとDTDの生成をメモリ上で行う設定をしています。次に、item、items、rootといったDTD要素をstartDtdElementで定義した後、それぞれの定義の最後にXMLWriter::endDtdElementを呼び出して、各要素の定義ブロックを適切に終了させています。これにより、<!ELEMENT root (items)>`のようなDTDルールが正確に形成されます。

DTDの定義が完了した後は、PHPの連想配列で表現された商品データをループ処理し、XMLWriter::startElementやwriteAttribute、writeElementメソッドを使って、DTDで定義された構造に沿った実際のXML要素を生成しています。このようにXMLWriterは、DTDの厳密な定義と、連想配列などのPHPデータ構造からXMLデータを効率的に生成する際に大変有用な機能を提供します。特にendDtdElementは、DTD内の要素定義の終了を明示する重要な役割を果たします。