【PHP8.x】DOMProcessingInstruction::childNodesプロパティの使い方

Copy
1<?php
2
3/**
4 * DOMProcessingInstruction の childNodes プロパティの使用例を示します。
5 *
6 * 処理命令 (Processing Instruction) は、XML文書内でアプリケーションへの情報を
7 * 埋め込むためのノードです (例: <?php-app ... ?>)。
8 *
9 * DOMProcessingInstruction ノードは、その仕様上、子ノードを持つことができません。
10 * そのため、`childNodes` プロパティにアクセスしても、常に空のノードリスト
11 * (DOMNodeList) が返され、その length プロパティは 0 となります。
12 * このコードは、その動作を確認するものです。
13 */
14function showProcessingInstructionChildNodes(): void
15{
16    // 処理命令 '<?php-app ...?>' を含むXML文字列を準備
17    $xmlString = <<<XML
18<?xml version="1.0" encoding="UTF-8"?>
19<root>
20    <element>Some text</element>
21    <?php-app action="log" message="processing"?>
22</root>
23XML;
24
25    // DOMDocumentオブジェクトを生成し、XMLを読み込む
26    $dom = new DOMDocument();
27    $dom->loadXML($xmlString);
28
29    // root要素の子ノードを順番に調べる
30    foreach ($dom->documentElement->childNodes as $node) {
31        // ノードが処理命令 (DOMProcessingInstruction) かどうかを判定
32        if ($node instanceof DOMProcessingInstruction) {
33            echo "処理命令ノードを発見しました。\n";
34            echo "ターゲット (target): " . $node->target . "\n"; // <?php-app の 'php-app' 部分
35            echo "データ (data): " . $node->data . "\n\n";       // action="log" ... の部分
36
37            // DOMProcessingInstructionのchildNodesプロパティを取得
38            // 戻り値はDOMNodeListオブジェクト
39            $childNodes = $node->childNodes;
40
41            echo "childNodesプロパティの型: " . get_class($childNodes) . "\n";
42            
43            // 処理命令ノードは子ノードを持たないため、lengthは常に0になる
44            echo "子ノードの数 (length): " . $childNodes->length . "\n";
45            
46            break; // 最初の処理命令を見つけたらループを抜ける
47        }
48    }
49}
50
51// 関数を実行して結果を表示
52showProcessingInstructionChildNodes();
53
54?>

PHPの DOMProcessingInstruction->childNodes プロパティは、処理命令ノードが持つ子ノードのリストを取得します。処理命令とは、XML文書内で <?target data?> のような形式で記述され、特定のアプリケーションに情報を伝えるための特別なノードです。

このプロパティにアクセスする際に引数は必要ありません。戻り値として、ノードの集合を管理するための DOMNodeList オブジェクトが返されます。

XMLの仕様上、処理命令ノードは子ノードを持つことができません。そのため、childNodes プロパティにアクセスすると、常に中身が空の DOMNodeList オブジェクトが返されます。結果として、このリストに含まれるノードの数を表す length プロパティの値は、常に 0 となります。

サンプルコードでは、まずXML文字列を読み込み、その中から <?php-app ...?> という処理命令ノードを探しています。そして、そのノードの childNodes プロパティを取得し、子ノードの数（length）が実際に 0 であることをコンソールに出力して確認しています。このコードは、処理命令ノードは子を持たないというルールを実証するものです。