【PHP8.x】XMLReader::END_ELEMENT定数の使い方

Copy
1<?php
2
3/**
4 * XMLReader を使用して XML を読み込み、要素の終了タグを検出する例です。
5 * while ループの代替構文である endwhile を使用してループを記述します。
6 *
7 * @param string $xmlString 処理する XML データを含む文字列。
8 * @return void
9 */
10function processXmlWithEndwhile(string $xmlString): void
11{
12    // XMLReader オブジェクトを作成します。
13    $reader = new XMLReader();
14
15    // XML 文字列を読み込みのソースとして設定します。
16    // ファイルから読み込む場合は $reader->open('file.xml') を使用します。
17    if (!$reader->XML($xmlString)) {
18        echo "エラー: XML データの読み込みに失敗しました。\n";
19        return;
20    }
21
22    echo "XML ドキュメントの解析を開始します。\n";
23
24    // XML ドキュメントをノードごとに順次読み込みます。
25    // while ($reader->read()): は while ($reader->read()) { ... } の代替構文です。
26    while ($reader->read()):
27        // 現在のノードのタイプをチェックします。
28        // XMLReader::END_ELEMENT は、要素の終了タグ (例: </item>) を示します。
29        if ($reader->nodeType === XMLReader::END_ELEMENT) {
30            // 終了タグを検出した場合、その要素名を出力します。
31            echo "  終了タグを検出しました: </{$reader->name}>\n";
32        }
33        // 参考として、要素の開始タグも表示してみます。
34        elseif ($reader->nodeType === XMLReader::ELEMENT) {
35            echo "開始タグを検出しました: <{$reader->name}>\n";
36        }
37    endwhile; // while ループの終了を示します。
38
39    // XMLReader のリソースを閉じます。
40    $reader->close();
41
42    echo "XML ドキュメントの解析が完了しました。\n";
43}
44
45// サンプル XML データ
46$sampleXml = <<<EOT
47<products>
48    <item id="A001">
49        <name>Laptop</name>
50        <price>1200</price>
51    </item>
52    <item id="A002">
53        <name>Mouse</name>
54        <price>25</price>
55    </item>
56</products>
57EOT;
58
59// 関数を実行して XML を解析します。
60processXmlWithEndwhile($sampleXml);
61
62?>

PHP 8のXMLReader拡張機能は、XMLドキュメントを効率的にストリーム処理するための機能を提供します。このサンプルコードは、XMLReaderクラスを使用してXMLドキュメントを読み込み、要素の終了タグを検出する方法を示すものです。

processXmlWithEndwhile関数は、引数としてXMLデータを含む文字列$xmlStringを受け取り、そのXMLを解析します。関数は処理結果を直接出力し、戻り値はvoidであるため何も返しません。

コードではまずXMLReaderオブジェクトを作成し、XMLメソッドでXML文字列を読み込みます。次に、while ($reader->read()):ループでXMLドキュメントをノードごとに順次読み進めます。ここで使用されているendwhileは、whileループのブロックを:とendwhile;で囲む代替構文であり、通常のwhile (...) { ... }と同じ機能を持ちます。

ループ内で$reader->nodeTypeがXMLReader::END_ELEMENTと等しい場合、現在のノードが要素の終了タグ（例: </item>)であることを意味します。この定数を利用することで、XMLドキュメントの構造内で特定の要素が終了した時点を正確に捉え、$reader->nameプロパティでその要素名を取得できます。コードは開始タグと終了タグを検出するたびにその要素名を出力し、解析の完了後にはXMLReaderのリソースを閉じます。

Copy
1<?php
2
3/**
4 * XMLReader を使用してXML文字列を解析し、検出された終了要素を
5 * endforeach 構文で表示するサンプルコードです。
6 */
7function parseXmlAndListEndElements(): void
8{
9    // 解析対象となるXMLデータ
10    $xmlString = <<<XML
11<library>
12    <book id="001">
13        <title>PHP for Beginners</title>
14        <author>John Doe</author>
15    </book>
16    <book id="002">
17        <title>Advanced PHP</title>
18        <author>Jane Smith</author>
19    </book>
20    <magazine issue="2023-01" />
21</library>
22XML;
23
24    $reader = new XMLReader();
25    // XMLReader にXML文字列を読み込ませます。
26    // (ファイルパスを指定する場合は $reader->open('path/to/file.xml') を使用)
27    if (!$reader->XML($xmlString)) {
28        echo "XMLの読み込みに失敗しました。\n";
29        return;
30    }
31
32    $endElementNames = [];
33
34    // XMLノードを先頭から順に読み進めます。
35    while ($reader->read()) {
36        // 現在のノードのタイプが終了要素（</tag>）であるかをチェックします。
37        // XMLReader::END_ELEMENT は、XMLの閉じタグ（例: </book>）を表す定数です。
38        if ($reader->nodeType === XMLReader::END_ELEMENT) {
39            // 検出された終了要素の名前を配列に格納します。
40            $endElementNames[] = $reader->name;
41        }
42    }
43
44    // XMLReader のリソースを解放します。
45    $reader->close();
46
47    echo "--- 検出された終了要素のリスト ---\n";
48
49    // 検出された終了要素の名前を endforeach 構文を使って表示します。
50    // endforeach は foreach ループの代替構文です（波括弧 {} の代わりに : と endforeach; を使います）。
51    foreach ($endElementNames as $elementName):
52        echo "終了要素: </{$elementName}>\n";
53    endforeach;
54}
55
56// 関数を実行してサンプルコードの動作を確認
57parseXmlAndListEndElements();

このサンプルコードは、PHPのXMLReaderクラスを利用してXMLデータを解析し、XMLの終了要素を検出して表示する方法を示しています。まず、XMLReaderオブジェクトを作成し、指定されたXML文字列を読み込みます。その後、while ($reader->read())ループを使ってXMLノードを順番に読み進めます。

ループ内で、現在のノードタイプがXMLReader::END_ELEMENT定数と一致するかどうかを確認します。XMLReader::END_ELEMENTは、XMLの終了タグ（例えば、<item>に対する</item>）を表す特別な定数です。この定数自体は引数を取らず、戻り値もありませんが、ノードタイプがこれに一致するということは、そのノードが終了要素であることを意味します。

終了要素が検出された場合、$reader->nameプロパティからその要素名を取得し、配列に格納します。全てのノードの読み込みが完了したら、XMLReaderのリソースを解放します。最後に、検出された終了要素の名前を、foreach ... endforeach;というPHPのループ構文を使って一覧表示します。このendforeach構文は、通常の波括弧{}の代わりにコロン:とendforeach;でループの範囲を示す、foreach文の代替表記です。このコードは、XML文書の構造を理解し、特定の要素をプログラムで扱うための基礎的な手法を学ぶのに役立ちます。