【PHP8.x】XMLReader::depthプロパティの使い方

Copy
1<?php
2
3/**
4 * XMLReader を使用して XML ドキュメントを深さ優先で走査し、各ノードの情報を出力します。
5 * depth プロパティを利用して現在のノードの深さを表示し、深さ優先探索の様子を表現します。
6 *
7 * @param string $xmlString 走査する XML ドキュメントの文字列。
8 * @return void
9 */
10function traverseXmlDepthFirst(string $xmlString): void
11{
12    $reader = new XMLReader();
13
14    // XML 文字列を XMLReader にロードします。
15    // ファイルパスから読み込む場合は $reader->open('path/to/file.xml') を使用します。
16    if (!$reader->xml($xmlString)) {
17        echo "エラー: XML のロードに失敗しました。\n";
18        return;
19    }
20
21    echo "XML ドキュメントを深さ優先で走査中...\n\n";
22
23    // XML ドキュメントをノードごとに読み進めます
24    while ($reader->read()) {
25        // XMLReader::depth プロパティで現在のノードの深さ（階層レベル）を取得します。
26        // これを使って出力にインデントをつけ、木構造の深さを視覚的に表現します。
27        $indent = str_repeat("  ", $reader->depth);
28
29        switch ($reader->nodeType) {
30            case XMLReader::ELEMENT: // 要素の開始タグ (<tag>)
31                echo "{$indent}ELEMENT: <{$reader->name}> (深さ: {$reader->depth})\n";
32                // 要素に属性がある場合、それらも走査して表示します
33                if ($reader->hasAttributes) {
34                    while ($reader->moveToNextAttribute()) {
35                        echo "{$indent}  ATTRIBUTE: {$reader->name}=\"{$reader->value}\"\n";
36                    }
37                    // 属性を読み込んだ後、元の要素ノードに戻ります
38                    $reader->moveToElement();
39                }
40                break;
41
42            case XMLReader::TEXT: // テキストノード (要素内のテキストコンテンツ)
43                // 空白のみのテキストノードは通常スキップして、出力を見やすくします
44                if (trim($reader->value) !== '') {
45                    echo "{$indent}TEXT: \"{$reader->value}\" (深さ: {$reader->depth})\n";
46                }
47                break;
48
49            case XMLReader::END_ELEMENT: // 要素の終了タグ (</tag>)
50                // 終了タグの出力は任意ですが、深さ優先探索の「バックトラック」を示すこともできます。
51                // echo "{$indent}END_ELEMENT: </{$reader->name}> (深さ: {$reader->depth})\n";
52                break;
53
54            // その他のノードタイプ（コメント、CDATAなど）も必要に応じて処理できます。
55            // default:
56            //     echo "{$indent}OTHER: Type " . $reader->nodeType . " (Name: {$reader->name}, Value: {$reader->value}) (深さ: {$reader->depth})\n";
57            //     break;
58        }
59    }
60
61    // XMLReader のリソースを解放します
62    $reader->close();
63    echo "\nXML ドキュメントの走査が完了しました。\n";
64}
65
66// サンプル XML ドキュメント文字列を定義します。
67// ヒアドキュメント構文 (<<<XML ... XML;) を使用して複数行の文字列を定義しています。
68$sampleXml = <<<XML
69<?xml version="1.0" encoding="UTF-8"?>
70<bookstore>
71    <book category="cooking">
72        <title lang="en">Everyday Italian</title>
73        <author>Giada De Laurentiis</author>
74        <year>2005</year>
75        <price>30.00</price>
76        <details>
77            <pages>256</pages>
78            <publisher>Penguin Random House</publisher>
79        </details>
80    </book>
81    <book category="children">
82        <title lang="en">Harry Potter</title>
83        <author>J.K. Rowling</author>
84        <year>2005</year>
85        <price>29.99</price>
86    </book>
87    <book category="web">
88        <title lang="en">Learning XML</title>
89        <author>Erik T. Ray</author>
90        <year>2003</year>
91        <price>39.95</price>
92    </book>
93</bookstore>
94XML;
95
96// 定義した関数を実行し、サンプルXMLを深さ優先で走査します。
97traverseXmlDepthFirst($sampleXml);

このPHPサンプルコードは、XMLReaderクラスを利用してXMLドキュメントを深さ優先で走査し、各ノードの情報を出力する方法を示しています。XMLReaderは、XMLファイルを効率的に読み込むための前方移動のみのパーサーです。

特に重要なのは、XMLReader::depthプロパティです。これは現在のノードがXML構造のどの深さ（階層レベル）にあるかを整数で返します。このコードでは、$reader->depthの値を使って出力にインデント（字下げ）を付けることで、XMLの木構造と深さ優先探索の進行状況を視覚的にわかりやすく表現しています。

traverseXmlDepthFirst関数は、引数として走査したいXMLドキュメントの文字列$xmlStringを受け取ります。この関数は、XMLReaderにXMLをロードした後、while ($reader->read())ループでXMLノードを一つずつ読み進めます。各ノードでは、そのタイプ（要素、テキストなど）に応じて、名前や値、そして現在の深さを表示します。属性がある場合はそれらも表示し、ノードの情報を詳細に確認できます。この関数は処理結果をコンソールに出力するだけで、特定の値を返さないため、戻り値はvoidです。これにより、システムエンジニアを目指す方がXMLデータの階層構造と走査ロジックを効率的に理解できるよう設計されています。