【PHP8.x】Dom\ProcessingInstruction::parentNodeプロパティの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * このスクリプトは、XML内の処理命令ノード(Processing Instruction)を取得し、
7 * その親ノードを `parentNode` プロパティを使って見つける方法を示します。
8 */
9
10// 1. DOMDocumentオブジェクトをインスタンス化します。
11$dom = new DOMDocument();
12
13// 2. 処理命令 `<?xml-stylesheet ... ?>` を含むXML文字列を定義します。
14$xmlString = <<<XML
15<?xml version="1.0" encoding="UTF-8"?>
16<?xml-stylesheet type="text/css" href="style.css"?>
17<root>
18    <item>コンテンツ</item>
19</root>
20XML;
21
22// XML文字列を読み込み、DOMツリーを構築します。
23$dom->loadXML($xmlString);
24
25// 3. 処理命令ノード (`Dom\ProcessingInstruction`) を取得します。
26//    ドキュメント直下の子ノードをループして、目的のノードタイプを探します。
27$processingInstructionNode = null;
28foreach ($dom->childNodes as $node) {
29    // ノードが処理命令であるかを確認します。
30    if ($node instanceof DOMProcessingInstruction) {
31        $processingInstructionNode = $node;
32        break;
33    }
34}
35
36// 4. 処理命令ノードが見つかった場合、その親ノードにアクセスします。
37if ($processingInstructionNode) {
38    echo "処理命令が見つかりました: " . $processingInstructionNode->target . PHP_EOL;
39
40    // `parentNode` プロパティを使用して親ノードを取得します。
41    // この例では、処理命令はXMLドキュメントの最上位にあるため、
42    // 親ノードはドキュメントノード全体になります。
43    $parentNode = $processingInstructionNode->parentNode;
44
45    if ($parentNode) {
46        // 親ノードのノード名を出力します。ドキュメントノードの場合、'#document' となります。
47        echo "親ノードのノード名: " . $parentNode->nodeName . PHP_EOL;
48        // 親ノードのクラス名（型）を出力します。
49        echo "親ノードの型: " . get_class($parentNode) . PHP_EOL;
50    } else {
51        echo "親ノードが見つかりませんでした。" . PHP_EOL;
52    }
53} else {
54    echo "処理命令ノードが見つかりませんでした。" . PHP_EOL;
55}
56
57?>

Dom\ProcessingInstructionクラスのparentNodeプロパティは、XML文書内にある処理命令ノードの親ノードを取得するために使用されます。このプロパティにアクセスすることで、XMLの階層構造において、現在の処理命令ノードがどのノードの直下に配置されているかを知ることができます。

このプロパティは引数を取らず、アクセスするだけで値を取得できます。戻り値として、親ノードを表すDom\Nodeオブジェクトが返されます。親ノードが存在しない場合、例えばノードがまだドキュメントツリーに追加されていない状態などではnullが返ります。

サンプルコードでは、まずXML文字列を読み込み、その中から<?xml-stylesheet ... ?>という処理命令ノードを探しています。次に見つけた処理命令ノードのparentNodeプロパティを使い、その親ノードを取得しています。この例では、処理命令がXML文書の最上位に直接配置されているため、親ノードは文書全体を表現するDom\Documentオブジェクト（ノード名は#document）となります。このようにparentNodeプロパティを利用することで、特定のノードの文書内での位置関係を把握し、階層を遡るような操作が可能になります。