【PHP8.x】nodeTypeプロパティの使い方

Copy
1<?php
2
3/**
4 * DOMNameSpaceNode (論理クラス) の nodeType プロパティの動作を示す関数。
5 *
6 * PHP の DOM 拡張において、DOMNameSpaceNode は XPath の 'namespace::' 軸から取得される
7 * 名前空間ノードを表す概念的なクラスです。
8 * 実際には DOMNode のインスタンスとして取得され、その nodeType プロパティが
9 * DOMNode::NAMESPACE_NODE (整数値) となります。
10 *
11 * この関数では、名前空間を含むXMLをパースし、DOMXPath を使って名前空間ノードを取得、
12 * その nodeType プロパティの値を確認します。
13 */
14function demonstrateDomNameSpaceNodeType(): void
15{
16    // 名前空間を持つシンプルなXML文字列を作成
17    $xmlString = <<<XML
18<?xml version="1.0" encoding="UTF-8"?>
19<root xmlns:myPrefix="http://example.com/my-namespace">
20    <myPrefix:element>Content</myPrefix:element>
21</root>
22XML;
23
24    // DOMDocument オブジェクトを作成し、XML文字列をロード
25    $dom = new DOMDocument();
26    $dom->loadXML($xmlString);
27
28    // DOMXPath オブジェクトを作成し、名前空間ノードをクエリ
29    // XPath の 'namespace::*' は、現在のコンテキストノードのスコープ内にある
30    // すべての名前空間ノードを選択します。
31    // ここではルート要素 'root' の名前空間ノードを検索しています。
32    $xpath = new DOMXPath($dom);
33    // DOMXPath::query() は DOMNodeList を返します。
34    // リスト内の各ノードは DOMNode のインスタンスですが、
35    // nodeType が DOMNode::NAMESPACE_NODE の場合、論理的に名前空間ノードとして扱われます。
36    $namespaceNodes = $xpath->query('//root/namespace::*');
37
38    echo "DOMNode::nodeType (名前空間ノードの場合) のデモンストレーション:\n";
39    echo "--------------------------------------------------\n";
40
41    if ($namespaceNodes->length > 0) {
42        foreach ($namespaceNodes as $node) {
43            // 取得したノードの実際のクラス名を表示（通常は DOMNode）
44            echo "取得ノードのクラス: " . get_class($node) . "\n";
45            // 名前空間ノードの nodeName はプレフィックス ('myPrefix')
46            echo "ノード名 (prefix): " . $node->nodeName . "\n";
47            // 名前空間ノードの nodeValue は名前空間URI ('http://example.com/my-namespace')
48            echo "ノード値 (URI): " . $node->nodeValue . "\n";
49            // nodeType プロパティの値を取得
50            echo "nodeType: " . $node->nodeType . "\n";
51            // DOMNode::NAMESPACE_NODE 定数の値と比較
52            echo "DOMNode::NAMESPACE_NODE の定数値: " . DOMNode::NAMESPACE_NODE . "\n";
53
54            // nodeType が DOMNode::NAMESPACE_NODE と一致するかを確認
55            if ($node->nodeType === DOMNode::NAMESPACE_NODE) {
56                echo "-> このノードの nodeType は DOMNode::NAMESPACE_NODE と一致します。\n";
57                echo "   これはXMLの名前空間ノードであることを示します。\n";
58            } else {
59                echo "-> このノードの nodeType は DOMNode::NAMESPACE_NODE と一致しません。\n";
60            }
61            echo "\n";
62        }
63    } else {
64        echo "指定されたXML内で名前空間ノードが見つかりませんでした。\n";
65    }
66}
67
68// 関数を実行して結果を表示
69demonstrateDomNameSpaceNodeType();

このサンプルコードは、PHPのDOM拡張機能において、XMLの名前空間ノードが持つnodeTypeプロパティの動作を説明しています。nodeTypeプロパティは、XMLツリー内の各ノードがどのような種類であるかを整数値で識別するためのものです。DOMNameSpaceNodeは、XMLの名前空間情報を表す特別なノードであり、実際にPHPのDOMではDOMNodeのインスタンスとして取得されます。

コードでは、まず名前空間を定義したXML文字列を作成し、DOMDocumentクラスを使ってXMLを読み込みます。その後、DOMXPathを使用してXMLの中から名前空間ノード（XPathのnamespace::*で指定）を検索しています。検索によって得られたノードはDOMNodeのインスタンスですが、そのnodeTypeプロパティは引数を取らず、DOMNode::NAMESPACE_NODEという特定の整数値（int型）を返します。この値によって、そのノードがXMLの名前空間ノードであることが判別できます。また、名前空間ノードのnodeNameにはプレフィックスが、nodeValueには名前空間のURIが格納されていることも確認できます。

Copy
1<?php
2
3/**
4 * XML文字列を解析し、見つかったDOMNameSpaceNodeのnodeTypeプロパティを取得します。
5 *
6 * @param string $xmlString 処理するXML文字列
7 * @return array DOMNameSpaceNodeのnodeType情報を含む文字列の配列
8 */
9function analyzeNamespaceNodeType(string $xmlString): array
10{
11    $results = [];
12
13    // XMLReaderはストリーミングでXMLを読み込むために使われます。
14    // ここではXMLコンテンツの準備に利用しますが、DOMNameSpaceNodeの検出にはDOMDocumentとDOMXPathが適しています。
15    $reader = new XMLReader();
16    if (!$reader->xml($xmlString)) {
17        $results[] = "XML文字列の読み込みに失敗しました。";
18        return $results;
19    }
20    $reader->close(); // XMLReaderの役割はここで終了
21
22    // DOMDocumentにXML全体をロードし、DOMツリーを構築します。
23    $dom = new DOMDocument();
24    if (!$dom->loadXML($xmlString, LIBXML_NOERROR | LIBXML_NOWARNING)) {
25        $results[] = "DOMDocumentへのXMLロードに失敗しました。";
26        return $results;
27    }
28
29    // DOMXPathを使用して、DOMツリーから特定のノードを検索します。
30    $xpath = new DOMXPath($dom);
31
32    // XPathクエリ 'namespace::*' は、名前空間ノードを選択します。
33    // これらのノードはDOMNameSpaceNode型として扱われます (DOMNodeを継承)。
34    $namespaceNodes = $xpath->query('//namespace::*');
35
36    if ($namespaceNodes->length === 0) {
37        $results[] = "DOMNameSpaceNodeは見つかりませんでした。";
38    } else {
39        foreach ($namespaceNodes as $node) {
40            // DOMNameSpaceNodeはDOMNodeを継承しており、nodeTypeプロパティを持ちます。
41            // nodeTypeはノードの種類を示す整数値です。
42            $nodeType = $node->nodeType;
43            $nodeName = $node->nodeName;   // 名前空間のプレフィックス (例: 'xsi', 'xmlns')
44            $nodeValue = $node->nodeValue; // 名前空間のURI
45
46            $results[] = sprintf(
47                "名前空間ノード: '%s' = '%s', nodeType = %d",
48                $nodeName,
49                $nodeValue,
50                $nodeType
51            );
52
53            // DOM_NAMESPACE_NODEは、名前空間ノードのタイプを示す組み込み定数です。
54            if ($nodeType === DOM_NAMESPACE_NODE) {
55                $results[] = "  (nodeTypeはDOM_NAMESPACE_NODEと一致します)";
56            } else {
57                $results[] = "  (nodeTypeはDOM_NAMESPACE_NODEと一致しません)";
58            }
59        }
60    }
61
62    return $results;
63}
64
65// サンプルXML文字列
66$sampleXml = <<<XML
67<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://example.com/ns1">
68    <child xsi:nil="true">
69        <grandchild xmlns:p="http://example.com/ns2">Hello World</grandchild>
70    </child>
71</root>
72XML;
73
74// 関数を実行し、結果を出力します。
75foreach (analyzeNamespaceNodeType($sampleXml) as $line) {
76    echo $line . PHP_EOL;
77}
78

このPHPサンプルコードは、XML文書内から「名前空間ノード（DOMNameSpaceNode）」を特定し、その「nodeType」プロパティがどのような値を持つかを示すものです。nodeTypeプロパティは、DOMNameSpaceNodeクラスに属し、XML文書におけるノードの種類を整数値で表現します。特に名前空間ノードの場合、PHPが提供する組み込み定数DOM_NAMESPACE_NODEと同じ整数値を返します。

analyzeNamespaceNodeType関数は、引数として解析したいXML文字列を受け取ります。関数内部では、まずXML文字列をDOMDocumentに読み込み、XML文書全体のDOMツリーを構築します。その後、DOMXPathを使用してXPathクエリ「//namespace::*」を実行し、文書内のすべての名前空間ノードを効率的に検索します。見つかった各名前空間ノードについて、nodeTypeプロパティの値を抽出し、ノード名（プレフィックス）やノード値（URI）と合わせて結果の配列に追加します。戻り値は、処理結果や見つかった名前空間ノードのnodeType情報を含む文字列の配列です。このコードを通じて、XMLの名前空間ノードの扱い方と、そのタイプをプログラム的に判別する方法を学ぶことができます。