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

Copy
1<?php
2
3/**
4 * Dom\ProcessingInstruction::previousSibling プロパティの使用例。
5 * このプロパティは、現在の処理命令ノードの直前の兄弟ノードを取得します。
6 * システムエンジニアを目指す初心者がDOM操作を理解するのに役立つよう、
7 * XMLの読み込みから兄弟ノードの取得・表示までの基本的な流れを示します。
8 */
9function demonstrateProcessingInstructionPreviousSibling(): void
10{
11    // DOMDocument オブジェクトを生成し、XMLを読み込みます。
12    $dom = new DOMDocument('1.0', 'UTF-8');
13    // 空白ノード（改行やインデントなど）を無視する設定です。
14    // これにより、previousSibling が意図しないテキストノードを返さないようになります。
15    $dom->preserveWhiteSpace = false;
16
17    // サンプルXML文字列。<?target ...?> が処理命令ノードです。
18    // その直前の兄弟ノードは <elementA> です。
19    $xmlString = <<<XML
20<?xml version="1.0" encoding="UTF-8"?>
21<root>
22    <elementA>最初の要素です。</elementA>
23    <?target instruction data?>
24    <elementB>2番目の要素です。</elementB>
25</root>
26XML;
27
28    // XML文字列をDOMDocumentにロードします。
29    $dom->loadXML($xmlString);
30
31    echo "--- Dom\\ProcessingInstruction::previousSibling のデモンストレーション ---\n\n";
32
33    // ドキュメントから Dom\ProcessingInstruction ノードを探します。
34    // ルート要素の子ノードを走査し、処理命令ノードを見つけます。
35    $processingInstructionNode = null;
36    if ($dom->documentElement) {
37        foreach ($dom->documentElement->childNodes as $node) {
38            if ($node instanceof Dom\ProcessingInstruction) {
39                $processingInstructionNode = $node;
40                echo "処理命令ノードを発見しました。\n";
41                echo "  ターゲット: '{$processingInstructionNode->target}'\n";
42                echo "  データ: '{$processingInstructionNode->data}'\n";
43                break; // 最初の処理命令ノードでOK
44            }
45        }
46    }
47
48    if ($processingInstructionNode) {
49        // previousSibling プロパティを使って、直前の兄弟ノードを取得します。
50        // 戻り値は ?Dom\Node なので、ノードが存在しない場合は null になります。
51        $previousSibling = $processingInstructionNode->previousSibling;
52
53        echo "\n--- 取得した処理命令ノードの直前の兄弟ノードの情報 ---\n";
54
55        if ($previousSibling) {
56            echo "  ノード名: " . $previousSibling->nodeName . "\n";
57            echo "  ノードタイプ: " . $previousSibling->nodeType . " (例: DOMElementは1, DOMTextは3)\n";
58            echo "  ノード値 (内容): " . ($previousSibling->nodeValue ?: '[値なし]') . "\n";
59
60            // もし直前のノードが DOMElement であれば、追加情報も表示します。
61            if ($previousSibling instanceof DOMElement) {
62                echo "  これは DOMElement (要素ノード) です。\n";
63                echo "  タグ名: " . $previousSibling->tagName . "\n";
64                echo "  textContent: " . $previousSibling->textContent . "\n";
65            }
66        } else {
67            echo "  直前の兄弟ノードはありませんでした。\n";
68        }
69    } else {
70        echo "ドキュメント内に Dom\\ProcessingInstruction ノードが見つかりませんでした。\n";
71    }
72}
73
74// デモンストレーション関数を実行します。
75demonstrateProcessingInstructionPreviousSibling();
76
77?>

このサンプルコードは、PHPのDOM拡張機能におけるDom\ProcessingInstructionクラスのpreviousSiblingプロパティの使用方法をデモンストレーションしています。previousSiblingプロパティは、現在の処理命令ノードの直前にある兄弟ノードを取得するために使われます。

コードではまず、XMLを扱うためのDOMDocumentオブジェクトを生成し、サンプルXML文字列を読み込みます。ここで$dom->preserveWhiteSpace = false;を設定することで、XML内の改行やインデントといった空白がノードとして扱われることを防ぎ、意図しないテキストノードを取得する可能性を低減しています。

XMLがロードされた後、ドキュメントのルート要素から処理命令ノード（例: <?target instruction data?>）を探索します。処理命令ノードが見つかると、そのノードに対してpreviousSiblingプロパティにアクセスし、直前の兄弟ノードを取得します。

このプロパティは引数を取りません。戻り値は?Dom\Node型で、直前の兄弟ノードが存在する場合はDom\Nodeオブジェクトを返しますが、存在しない場合はnullを返します。サンプルコードでは、取得したノードが存在するかどうかを確認し、存在すればそのノードの名前、タイプ、値などを表示しています。これにより、XMLツリー構造における兄弟ノードの関係性と、その情報をプログラムでどのように取得・利用できるかを学ぶことができます。

Copy
1<?php
2
3/**
4 * Demonstrates the Dom\ProcessingInstruction::previousSibling property.
5 *
6 * This function creates a simple XML document programmatically, inserts
7 * a Processing Instruction between two elements, and then retrieves its
8 * previous sibling to show how the property works. It also includes
9 * a case where a Processing Instruction has no previous sibling.
10 */
11function demonstrateProcessingInstructionPreviousSibling(): void
12{
13    // 1. Create a new DOMDocument instance
14    $dom = new Dom\Document('1.0', 'UTF-8');
15    $dom->formatOutput = true; // For cleaner XML output
16
17    // 2. Create the root element
18    $root = $dom->createElement('root');
19    $dom->appendChild($root);
20
21    // 3. Create a first element and append it to the root
22    $element1 = $dom->createElement('item1', 'This is the first element.');
23    $root->appendChild($element1);
24
25    // 4. Create a Processing Instruction node
26    //    - 'php' is the target (e.g., 'xml-stylesheet', 'php', etc.)
27    //    - 'echo "Hello from PI!";' is the data for the instruction
28    $processingInstruction = $dom->createProcessingInstruction('php', 'echo "Hello from PI!";');
29    $root->appendChild($processingInstruction);
30
31    // 5. Create a second element and append it after the Processing Instruction
32    $element2 = $dom->createElement('item2', 'This is the second element.');
33    $root->appendChild($element2);
34
35    echo "--- Generated Document Structure (simplified) ---\n";
36    // saveXML() includes the XML declaration and current document content
37    echo $dom->saveXML() . "\n";
38
39    echo "--- Demonstrating previousSibling on Dom\\ProcessingInstruction ---\n";
40
41    // Display details of the current Processing Instruction
42    echo "Details of the target ProcessingInstruction:\n";
43    echo "  Node Type: " . get_class($processingInstruction) . "\n";
44    echo "  Node Name (Target): " . $processingInstruction->nodeName . "\n"; // 'php' in this case
45    echo "  Node Value (Data): " . $processingInstruction->nodeValue . "\n"; // 'echo "Hello from PI!";'
46    echo "  Specific Target Property: " . $processingInstruction->target . "\n";
47    echo "  Specific Data Property: " . $processingInstruction->data . "\n\n";
48
49    // 6. Access the 'previousSibling' property
50    //    This property returns the node immediately preceding this node,
51    //    or null if there is no such node.
52    $previousSibling = $processingInstruction->previousSibling;
53
54    echo "Checking the previousSibling of the ProcessingInstruction:\n";
55
56    if ($previousSibling !== null) {
57        echo "  Previous Sibling found!\n";
58        echo "  Type: " . get_class($previousSibling) . "\n";
59        echo "  Node Name: " . $previousSibling->nodeName . "\n";
60
61        // Provide more specific information based on the node type
62        if ($previousSibling instanceof Dom\Element) {
63            echo "  Is Dom\\Element. Tag Name: " . $previousSibling->tagName . "\n";
64            echo "  Content: " . $previousSibling->textContent . "\n";
65        } elseif ($previousSibling instanceof Dom\Text) {
66            echo "  Is Dom\\Text. Text Content: '" . trim($previousSibling->nodeValue) . "'\n";
67        }
68        echo "  Node Value: " . $previousSibling->nodeValue . "\n"; // Note: For elements, nodeValue is typically empty unless it's a text-only node
69    } else {
70        echo "  No previous sibling found for this ProcessingInstruction.\n";
71    }
72    echo "\n";
73
74    // --- Demonstrating a case where a ProcessingInstruction is the first child ---
75    echo "--- Demonstrating case with no previousSibling ---\n";
76    $domNoPrev = new Dom\Document('1.0', 'UTF-8');
77    $rootNoPrev = $domNoPrev->createElement('root');
78    $domNoPrev->appendChild($rootNoPrev);
79
80    // Create a Processing Instruction as the first child of the root
81    $piFirstChild = $domNoPrev->createProcessingInstruction('first_pi', 'This is the very first node.');
82    $rootNoPrev->appendChild($piFirstChild);
83
84    // Add another element after it
85    $elementAfter = $domNoPrev->createElement('after_pi', 'Node after the first PI.');
86    $rootNoPrev->appendChild($elementAfter);
87
88    echo "ProcessingInstruction (as the first child) details:\n";
89    echo "  Node Name (Target): " . $piFirstChild->nodeName . "\n";
90    echo "  Node Value (Data): " . $piFirstChild->nodeValue . "\n\n";
91
92    // Try to get its previous sibling
93    $noPreviousSibling = $piFirstChild->previousSibling;
94
95    echo "Checking previousSibling for the first child PI:\n";
96    if ($noPreviousSibling !== null) {
97        echo "  Previous Sibling found! (This should not happen here).\n";
98        echo "  Type: " . get_class($noPreviousSibling) . "\n";
99    } else {
100        echo "  No previous sibling found, as expected, because it's the first child.\n";
101    }
102}
103
104// Execute the demonstration function
105demonstrateProcessingInstructionPreviousSibling();
106
107?>

PHPのDom\ProcessingInstruction::previousSiblingは、XMLドキュメント内で特定の「処理命令」（Processing Instruction）ノードの直前に位置する兄弟ノードを取得するためのプロパティです。

このプロパティには引数がなく、戻り値として?Dom\Nodeが返されます。これは、前の兄弟ノードが存在する場合はそのノードを表すDom\Nodeオブジェクトを返し、もし前の兄弟ノードが全く存在しない場合はnullを返すことを意味しています。

サンプルコードでは、XMLドキュメント内に<item1>要素、続いて処理命令、そして<item2>要素を配置した構造を作成しています。ここで処理命令のpreviousSiblingプロパティにアクセスすると、直前の兄弟ノードである<item1>要素が取得される様子が確認できます。取得されたノードの型（例: Dom\Element）や内容も詳細に表示されます。

さらに、処理命令が親ノードの最初の子ノードとして存在する別のケースも示されています。この場合、処理命令の前に兄弟ノードは存在しないため、previousSiblingは期待通りnullを返します。このプロパティは、DOMツリーのノード間を移動し、前後の関係性を効率的に把握するために役立ちます。