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

Copy
1<?php
2
3/**
4 * Dom\XMLDocument の isConnected プロパティの動作を示すサンプルコードです。
5 *
6 * Dom\Node (Dom\XMLDocument もこれを継承) の isConnected プロパティは、
7 * そのノードが Dom\XMLDocument (ルートドキュメント) のツリー構造に
8 * 直接的または間接的に接続されているかどうかを示す真偽値 (bool) を返します。
9 *
10 * これは、例えばMQTTクライアントがブローカーに接続されているかを確認するのと同様に、
11 * 何か（ここではXMLノード）が特定のコンテキスト（XMLドキュメント）に「属しているか」「接続されているか」
12 * を判断する際に役立つ概念です。
13 */
14function demonstrateXmlNodeConnectionStatus(): void
15{
16    // 1. 新しい Dom\XMLDocument オブジェクトを作成します。
17    // これはDOMツリーのルートとなる空のXMLドキュメントです。
18    $document = new Dom\XMLDocument();
19    echo "--- ドキュメント作成直後 ---\n";
20
21    // Dom\XMLDocument オブジェクト自体も Dom\Node を継承しているため、
22    // isConnected プロパティを持ちます。自身のドキュメントに常に接続されていると見なされます。
23    echo "Dom\\XMLDocument オブジェクト自体の isConnected: " . ($document->isConnected ? 'true' : 'false') . "\n\n";
24
25    // 2. XML コンテンツをドキュメントにロードします。
26    // ロードされた要素は自動的にドキュメントツリーに接続されます。
27    $document->loadXML('<root><item id="firstItem">最初の子要素</item></root>');
28    echo "--- XML コンテンツロード後 ---\n";
29
30    // ドキュメントのルート要素を取得します。
31    $rootElement = $document->documentElement;
32    if ($rootElement instanceof Dom\Element) {
33        echo "ルート要素 ('{$rootElement->tagName}') の isConnected: " . ($rootElement->isConnected ? 'true' : 'false') . "\n";
34    }
35
36    // ドキュメント内の特定の要素をIDで取得します。
37    $firstItem = $document->getElementById('firstItem');
38    if ($firstItem instanceof Dom\Element) {
39        echo "ID 'firstItem' の要素 ('{$firstItem->tagName}') の isConnected: " . ($firstItem->isConnected ? 'true' : 'false') . "\n\n";
40    }
41
42    // 3. まだドキュメントに追加されていない新しい要素を作成します。
43    // この段階ではドキュメントツリーに接続されていないため、isConnected は false です。
44    $newElement = $document->createElement('newItem');
45    $newElement->textContent = '新しく作成された要素';
46    echo "--- ドキュメントに追加されていない新しい要素 ---\n";
47    echo "新しい要素 ('{$newElement->tagName}') の isConnected (追加前): " . ($newElement->isConnected ? 'true' : 'false') . "\n\n";
48
49    // 4. 新しい要素をドキュメントツリーに追加します。
50    // 追加後、この要素はドキュメントに接続された状態になります。
51    if ($rootElement instanceof Dom\Element) {
52        $rootElement->appendChild($newElement);
53        echo "--- ドキュメントに追加された新しい要素 ---\n";
54        echo "新しい要素 ('{$newElement->tagName}') の isConnected (追加後): " . ($newElement->isConnected ? 'true' : 'false') . "\n\n";
55    }
56
57    // 5. ドキュメントから特定の要素を削除します。
58    // 削除された要素はドキュメントツリーから切り離されるため、isConnected は false になります。
59    if ($rootElement instanceof Dom\Element && $firstItem instanceof Dom\Element) {
60        $rootElement->removeChild($firstItem);
61        echo "--- ドキュメントから削除された要素 ---\n";
62        echo "ID 'firstItem' の要素 ('{$firstItem->tagName}') の isConnected (削除後): " . ($firstItem->isConnected ? 'true' : 'false') . "\n\n";
63    }
64}
65
66// サンプル関数を実行します。
67demonstrateXmlNodeConnectionStatus();
68

PHP 8のDom\XMLDocumentクラスに属するisConnectedプロパティは、そのノードがXMLドキュメントのツリー構造に現在接続されているかどうかを示す真偽値（bool）を返します。このプロパティは引数を取りません。

このサンプルコードは、Dom\XMLDocument内の各要素がドキュメントツリーにどのように接続されているか、その状態がisConnectedプロパティによってどのように示されるかを解説しています。最初に新しいDom\XMLDocumentを作成すると、そのドキュメント自体は常に接続されていると見なされ、isConnectedはtrueです。

XMLコンテンツをドキュメントにロードすると、ロードされた要素は自動的にドキュメントツリーに接続されるため、それらのisConnectedもtrueとなります。一方で、createElement()などで新しく作成された要素は、まだドキュメントツリーに追加されていない状態ではisConnectedがfalseを示します。この新しい要素を既存のドキュメントに追加すると、isConnectedはtrueに変化し、ドキュメントツリーへの接続状態が確認できます。さらに、ドキュメントから要素を削除した場合、その要素はツリーから切り離されるため、isConnectedは再びfalseに戻ります。このプロパティは、XMLノードが特定のドキュメントの一部であるかを効率的に判別する際に役立ちます。

Copy
1<?php
2
3/**
4 * Demonstrates the use of Dom\XMLDocument::isConnected property in PHP.
5 * This property indicates whether a DOM node is part of a document tree.
6 *
7 * Note: The Dom\XMLDocument class and its properties like `isConnected` are
8 * available from PHP 8.3. For earlier PHP 8 versions (e.g., 8.0-8.2), you
9 * would typically use the DOMDocument class, which has similar functionalities
10 * for XML manipulation but does not expose an `isConnected` property directly
11 * on the document itself in the same way. The `isConnected` property is part
12 * of the Dom\Node interface, which Dom\XMLDocument implements.
13 *
14 * This example focuses on the connection state of a node within the DOM tree.
15 * It is distinct from network connection states (e.g., "paho connection lost").
16 * Network connection management is typically handled by specific client libraries
17 * (like a Paho MQTT client) and involves network protocols and socket states,
18 * not the internal structure of an XML document.
19 */
20function demonstrateDomNodeConnection(): void
21{
22    // Create a new XML document instance.
23    // This requires PHP 8.3 or newer to execute successfully.
24    if (!class_exists('Dom\XMLDocument')) {
25        echo "Error: Dom\\XMLDocument class is not available. This example requires PHP 8.3 or newer.\n";
26        return;
27    }
28
29    $document = new Dom\XMLDocument();
30    echo "XML document created.\n";
31
32    // The document itself is the root of the tree and is always considered connected.
33    echo "Document is connected: " . ($document->isConnected ? "true" : "false") . "\n";
34
35    // Create a new element node, but do not append it to the document yet.
36    $rootElement = $document->createElement('data');
37    echo "Root element 'data' created.\n";
38
39    // Before appending, the element is not connected to any document tree.
40    echo "Root element 'data' is connected (before append): " . ($rootElement->isConnected ? "true" : "false") . "\n";
41
42    // Append the element to the document.
43    $document->appendChild($rootElement);
44    echo "Root element 'data' appended to document.\n";
45
46    // After appending, the element is connected to the document tree.
47    echo "Root element 'data' is connected (after append): " . ($rootElement->isConnected ? "true" : "false") . "\n";
48
49    // Create another element that will intentionally not be appended.
50    $orphanElement = $document->createElement('orphan');
51    echo "Orphan element 'orphan' created.\n";
52
53    // This element remains an "orphan" and is not connected.
54    echo "Orphan element 'orphan' is connected: " . ($orphanElement->isConnected ? "true" : "false") . "\n";
55}
56
57// Execute the demonstration function.
58demonstrateDomNodeConnection();
59

このサンプルコードは、PHP 8.3以降で利用可能なDom\XMLDocumentクラスのisConnectedプロパティの動作を示しています。isConnectedプロパティは、XMLドキュメントのDOMツリーにおいて、特定のノードがそのドキュメントツリーの一部として実際に接続されているかどうかを真偽値（bool）で返します。このプロパティには引数はありません。

ここでいう「接続」とは、XMLドキュメントの内部構造におけるノードの親子関係を指し、インターネット接続やネットワークの接続状態（例えば「paho connection lost」のようなMQTTクライアントの接続状態）とは全く異なりますのでご注意ください。

コードではまず、新しいXMLドキュメントを作成し、ドキュメント自体は常に接続状態にあることを確認します。次に、新しい要素（data）を作成し、まだドキュメントに追加されていない時点ではisConnectedがfalseであることを示します。この要素をドキュメントに追加すると、isConnectedはtrueに変わります。また、ドキュメントに追加されないままの要素（orphan）は、常にisConnectedがfalseのままであることも確認できます。これにより、ノードがドキュメントツリーに属しているかどうかの判断にこのプロパティが利用できることがわかります。