【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データの階層構造と走査ロジックを効率的に理解できるよう設計されています。

Copy
1<?php
2
3/**
4 * XMLReader を使用してXML構造の深さを表示する関数。
5 *
6 * この関数はXMLをストリームベースで読み込み、各ノードの深さ (depth) を出力します。
7 * XMLReader::depth プロパティは、XMLドキュメント内での現在のノードの階層レベル（ルートは0）を示します。
8 * XMLReader はストリームベースであるため、深いXML構造を再帰処理なしでメモリ効率良く扱うことができ、
9 * PHPの再帰深度制限を気にすることなくXMLを処理するのに適しています。
10 *
11 * @param string $xmlString 処理するXML文字列
12 */
13function displayXmlNodeDepth(string $xmlString): void
14{
15    $reader = new XMLReader();
16
17    // XML文字列を開く
18    if (!$reader->xml($xmlString)) {
19        echo "エラー: XML文字列の読み込みに失敗しました。\n";
20        return;
21    }
22
23    echo "XML構造のノード深さを表示します:\n";
24
25    // XMLノードを順に読み込む
26    while ($reader->read()) {
27        // 現在のノードのタイプ、名前、深さを表示
28        // depth プロパティは、現在のノードの階層レベル（ルートノードの深さは0）を整数で返します。
29        echo sprintf(
30            "[%s] 名前: %-15s 深さ: %d\n",
31            XMLReader::nodeTypeToString($reader->nodeType), // ノードタイプを可読な文字列に変換 (PHP 8で追加)
32            $reader->name,  // ノードの名前 (例: 要素名、属性名)
33            $reader->depth  // 現在のノードの深さ
34        );
35    }
36
37    // XMLReader リソースを解放
38    $reader->close();
39}
40
41// サンプルXMLデータ
42// このXMLは、様々な深さを持つノードを含んでいます。
43$sampleXml = <<<XML
44<document>
45    <chapter title="はじめに">
46        <section id="sec-1">
47            <paragraph>これは最初の段落です。</paragraph>
48            <list>
49                <item>項目A</item>
50                <item>項目B</item>
51                <sublist>
52                    <item>副項目B-1</item>
53                    <item>副項目B-2</item>
54                </sublist>
55            </list>
56            <paragraph>これは2番目の段落です。</paragraph>
57        </section>
58        <section id="sec-2">
59            <paragraph>最後のセクションです。</paragraph>
60        </section>
61    </chapter>
62    <appendix>
63        <item>付録A</item>
64    </appendix>
65</document>
66XML;
67
68// 関数を実行し、結果を出力
69displayXmlNodeDepth($sampleXml);

PHP 8のXMLReader::depthプロパティは、XMLドキュメントをストリームベースで読み込む際に、現在のノードの階層レベル（深さ）を整数値で返します。ルートノードの深さは0です。このプロパティは引数を取らず、常にint型の値を戻り値として提供します。

XMLReaderクラスは、XML全体をメモリに読み込まずに要素を順次処理できるため、巨大なXMLデータや深い階層を持つ構造でもメモリ効率良く扱えます。これにより、PHPの最大再帰深度（php max recursion depth）制限を気にすることなく、XML構造を効率的に走査できる利点があります。

サンプルコードのdisplayXmlNodeDepth関数は、XMLReaderを用いてXML文字列を開き、while ($reader->read())ループでノードを一つずつ読み進めます。ループ内で$reader->depthプロパティを参照することで、現在処理中のノードの階層レベルを簡単に取得し、出力しています。XMLReader::nodeTypeToStringは、ノードタイプを分かりやすい文字列に変換するPHP 8の機能です。XMLReader::depthプロパティを活用することで、再帰処理なしでXML構造の深さを正確に把握し、メモリに優しい処理を実現できます。

Copy
1<?php
2
3/**
4 * XMLReaderクラスのdepthプロパティの使用例を示す関数です。
5 * XML文書を読み込み、各ノードの深さ(depth)を出力します。
6 *
7 * @return void
8 */
9function demonstrateXmlReaderDepth(): void
10{
11    // XMLReaderオブジェクトを新しく作成します。
12    $reader = new XMLReader();
13
14    // 読み込むXMLデータを文字列として定義します。
15    $xmlString = <<<XML
16<root>
17    <item id="1">
18        <name>Item A</name>
19        <value>100</value>
20    </item>
21    <item id="2">
22        <name>Item B</name>
23    </item>
24</root>
25XML;
26
27    // XMLReaderにXML文字列をロードします。
28    // 成功した場合のみ処理を続行します。
29    if (!$reader->xml($xmlString)) {
30        echo "XMLのロードに失敗しました。\n";
31        return;
32    }
33
34    echo "XML文書を読み込み、ノード名と深さ(depth)を表示します。\n";
35    echo "---------------------------------------------------\n";
36
37    // read()メソッドは、XMLの次のノードを読み込みます。
38    // 読み込むノードがなくなるとfalseを返します。
39    while ($reader->read()) {
40        // 現在のノードの名前と深さ(depth)を出力します。
41        // depthは、現在のノードがXML文書のルートからの相対的な深さを示します。
42        // ルート要素は0、その子要素は1、さらにその子要素は2となります。
43        echo "ノード名: " . $reader->name . ", ";
44        echo "深さ(depth): ";
45        // var_dumpを使用して、depthプロパティの型と値を確認します。
46        var_dump($reader->depth);
47    }
48
49    // XMLReaderのリソースを解放します。
50    $reader->close();
51
52    echo "---------------------------------------------------\n";
53    echo "XMLReaderの処理が完了しました。\n";
54}
55
56// 関数の実行
57demonstrateXmlReaderDepth();

PHPのXMLReaderクラスは、XML文書を効率的に読み込むための拡張機能を提供します。このクラスのdepthプロパティは、現在処理しているXMLノードがXML文書のルートからどのくらい深い位置にあるかを示す整数値（int型）を提供します。このプロパティには引数がなく、現在のノードの深さを直接取得できます。XMLのルート要素は深さ0として扱われ、その直下の子要素は深さ1、さらにその子要素は深さ2と、階層が深くなるにつれて値が増加します。

サンプルコードでは、まずXMLReaderオブジェクトを生成し、XML文字列をロードしています。その後、while ($reader->read())ループを用いてXML文書のノードを順次読み進めながら、各ノードの名前と$reader->depthプロパティで取得した深さの値を表示しています。特にvar_dump($reader->depth)の部分では、depthプロパティが返す値が整数型であることを具体的に確認できます。このdepthプロパティは、XMLの階層構造を理解し、現在のノードが文書のどこに位置するかを把握する上で非常に役立ちます。