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

Copy
1<?php
2
3/**
4 * DOMEntityReference::isConnected プロパティの動作をデモンストレーションする関数。
5 *
6 * このプロパティは、DOMノードがDOMドキュメントツリーに接続されているかどうかを示します。
7 * システムエンジニアを目指す初心者向けに、エンティティ参照がツリーに追加される前、後、削除後の
8 * isConnected の状態変化を明確に示します。
9 *
10 * キーワード "paho mqtt isconnected" はMQTTクライアントの接続状態を指しますが、
11 * ここで扱う "isConnected" はDOMノードがドキュメントツリーに接続されているかどうかを示します。
12 * 概念的には「接続されているか」という共通点がありますが、技術的な内容は全く異なります。
13 */
14function demonstrateDomEntityReferenceIsConnected(): void
15{
16    echo "=== DOMEntityReference::isConnected のデモンストレーション ===\n\n";
17
18    // 1. XMLドキュメントとDTDを作成
19    // DTD（Document Type Definition）を内部サブセットとして定義し、
20    // "&example;" という名前のエンティティを宣言します。
21    // これにより、後で DOMEntityReference が参照できるエンティティが存在する状態を作ります。
22    $xmlString = <<<XML
23<!DOCTYPE root [
24    <!ENTITY example "この部分はエンティティによって置き換えられます。">
25]>
26<root>
27    <item/>
28</root>
29XML;
30
31    // DOMDocument インスタンスを作成し、XML文字列をロードします。
32    $dom = new DOMDocument();
33    // 整形されたXML出力のために、空白ノードを無視し、formatOutputをtrueに設定します。
34    $dom->preserveWhiteSpace = false;
35    $dom->formatOutput = true;
36    $dom->loadXML($xmlString);
37
38    // root要素とitem要素を取得します。
39    $root = $dom->getElementsByTagName('root')->item(0);
40    $item = $dom->getElementsByTagName('item')->item(0);
41
42    // 2. DOMEntityReference のインスタンスを作成
43    // 宣言した "&example;" エンティティを参照するノードを作成します。
44    $entityRef = $dom->createEntityReference('example');
45
46    echo "--- 初期状態 ---\n";
47    // 作成直後、まだドキュメントツリーのどの部分にも追加されていない状態です。
48    // この時点では isConnected は false を返します。
49    echo "エンティティ参照作成直後 isConnected: " . ($entityRef->isConnected ? 'true' : 'false') . "\n";
50
51    // 3. DOMEntityReference をドキュメントツリーに追加
52    // <item>要素の子としてエンティティ参照ノードを追加します。
53    // これにより、ノードがドキュメントツリーに接続されます。
54    $item->appendChild($entityRef);
55
56    echo "\n--- ドキュメントツリーに追加後 ---\n";
57    // ドキュメントツリーに追加されたため、isConnected は true を返します。
58    echo "ドキュメントツリーに追加後 isConnected: " . ($entityRef->isConnected ? 'true' : 'false') . "\n";
59
60    echo "\n--- ドキュメントのXML出力（追加後）---\n";
61    // エンティティ参照が解決され、実際のコンテンツが表示されていることを確認します。
62    echo $dom->saveXML();
63
64    // 4. DOMEntityReference をドキュメントツリーから削除
65    // <item>要素からエンティティ参照ノードを削除します。
66    // これにより、ノードはドキュメントツリーから切り離されます。
67    $item->removeChild($entityRef);
68
69    echo "\n--- ドキュメントツリーから削除後 ---\n";
70    // ドキュメントツリーから削除されたため、isConnected は false を返します。
71    echo "ドキュメントツリーから削除後 isConnected: " . ($entityRef->isConnected ? 'true' : 'false') . "\n";
72
73    echo "\n--- ドキュメントのXML出力（削除後）---\n";
74    // エンティティ参照が削除されたため、そのコンテンツは表示されなくなります。
75    echo $dom->saveXML();
76
77    echo "\n========================================\n";
78}
79
80// 関数を実行し、デモンストレーションを開始します。
81demonstrateDomEntityReferenceIsConnected();

PHP 8のDOMEntityReference::isConnectedプロパティは、XMLドキュメント内で定義されたエンティティを参照するDOMEntityReferenceノードが、そのドキュメントのツリー構造に実際に接続されているかどうかを示す真偽値（bool）を返します。このプロパティは引数を取りません。

具体的には、DOMEntityReferenceオブジェクトがDOMDocumentによって作成された直後の状態では、まだツリーに組み込まれていないためfalseを返します。しかし、appendChild()などのメソッドを使用して親ノードの子としてドキュメントツリーに追加されると、isConnectedはtrueに変わります。その後、removeChild()などでツリーから切り離されると、再びfalseに戻ります。

このプロパティは、特定のDOMノードがXML構造の一部として有効に機能しているか、それとも独立した状態で存在しているかを確認する際に役立ちます。キーワードの「paho mqtt isconnected」はMQTTクライアントの接続状態を指すため、「接続されているか」という概念は共通していますが、DOMEntityReference::isConnectedが扱うのはDOMツリーへの接続状態であり、技術的な対象は異なりますのでご注意ください。

Copy
1<?php
2
3/**
4 * DOMEntityReference::isConnected プロパティのデモンストレーション。
5 *
6 * この関数は、DOMツリーにおけるDOMEntityReferenceノードの接続状態 (isConnected) を示します。
7 * ノードがドキュメントに接続されているか（true）または接続されていないか（false）を確認できます。
8 *
9 * 「paho connection lost」というキーワードに触発され、システム内の要素が
10 * 「接続を失う」または「接続を回復する」という状況を、DOMノードの接続状態の変化を通じて表現します。
11 *
12 * @return void
13 */
14function demonstrateDomEntityReferenceConnection(): void
15{
16    echo "DOMEntityReference::isConnected プロパティのデモンストレーション\n\n";
17
18    // ----------------------------------------------------------------------
19    // パターン1: XMLをパースして、既存のDOMEntityReferenceノードの接続状態を操作する
20    // ----------------------------------------------------------------------
21    echo "--- 既存のエンティティ参照ノードの操作 ---\n";
22
23    // DTD (文書型定義) とエンティティ参照を含むXMLをロードします。
24    // DOMEntityReferenceはXMLのDTDで定義されたエンティティを参照するノードです。
25    $xmlWithEntityRef = '<!DOCTYPE root [<!ENTITY myentity "My Entity Value">]><root>&myentity;</root>';
26    $domLoaded = new DOMDocument('1.0', 'UTF-8');
27    $domLoaded->loadXML($xmlWithEntityRef);
28    $domLoaded->formatOutput = true; // 出力を見やすくするための設定
29
30    // ロードしたDOMからroot要素と、その中のDOMEntityReferenceノードを探します。
31    /** @var DOMEntityReference|null $entityRefNode */
32    $entityRefNode = null;
33    $rootLoaded = $domLoaded->getElementsByTagName('root')->item(0);
34    if ($rootLoaded) {
35        foreach ($rootLoaded->childNodes as $childNode) {
36            if ($childNode instanceof DOMEntityReference) {
37                $entityRefNode = $childNode;
38                break;
39            }
40        }
41    }
42
43    if (!$entityRefNode) {
44        echo "エラー: DOMEntityReference ノードをXMLからロードできませんでした。\n";
45        return;
46    }
47
48    // 1. ノードがドキュメントに接続されている初期状態を確認
49    echo "1. ロード直後 (ドキュメントに接続済み):\n";
50    echo "   ノード名: " . $entityRefNode->nodeName . "\n";
51    echo "   isConnected: " . ($entityRefNode->isConnected ? 'true' : 'false') . "\n";
52
53    // 2. ノードを親から削除し、接続が失われた状態をシミュレート
54    // これは、システム内の重要な要素との「接続が失われた」状況に似ています。
55    $parentNode = $entityRefNode->parentNode;
56    if ($parentNode) {
57        $removedNode = $parentNode->removeChild($entityRefNode);
58        echo "\n2. 親から削除後 (接続解除):\n";
59        echo "   ノード名: " . $removedNode->nodeName . "\n";
60        echo "   isConnected: " . ($removedNode->isConnected ? 'true' : 'false') . "\n";
61
62        // 3. ノードを再度親に追加し、接続が回復した状態をシミュレート
63        // これは、システムが接続を「回復した」状況に似ています。
64        $parentNode->appendChild($removedNode);
65        echo "\n3. 再度親に追加後 (再接続):\n";
66        echo "   ノード名: " . $removedNode->nodeName . "\n";
67        echo "   isConnected: " . ($removedNode->isConnected ? 'true' : 'false') . "\n";
68    } else {
69        echo "エラー: エンティティ参照ノードに親ノードがありませんでした。\n";
70    }
71
72    echo "\n";
73
74    // --------------------------------------------------------------------
75    // パターン2: DOMDocument::createEntityReference で新規作成し、接続状態を操作する
76    // --------------------------------------------------------------------
77    echo "--- 新規作成したエンティティ参照ノードの操作 ---\n";
78
79    // 新しいDOMDocumentを作成し、DTDを定義してエンティティを認識させます。
80    $domNew = new DOMDocument('1.0', 'UTF-8');
81    $dtdForNewEntity = '<!DOCTYPE root [<!ENTITY new_entity "New Entity Value">]>';
82    $domNew->loadXML($dtdForNewEntity . '<root/>');
83    $domNew->formatOutput = true;
84
85    $rootNew = $domNew->getElementsByTagName('root')->item(0);
86    if (!$rootNew) {
87        echo "エラー: root要素が見つかりませんでした。\n";
88        return;
89    }
90
91    // 1. DOMEntityReference ノードを新規作成。この時点ではまだドキュメントツリーに未接続。
92    echo "1. 新規作成直後 (ドキュメントに未接続):\n";
93    $newEntityRef = $domNew->createEntityReference('new_entity');
94    echo "   ノード名: " . $newEntityRef->nodeName . "\n";
95    echo "   isConnected: " . ($newEntityRef->isConnected ? 'true' : 'false') . "\n";
96    // これは、何かのコンポーネントがまだシステムに「接続されていない」状態に似ています。
97
98    // 2. ノードをドキュメントツリーに追加し、接続状態にする
99    $rootNew->appendChild($newEntityRef);
100    echo "\n2. ドキュメントに追加後 (接続済み):\n";
101    echo "   ノード名: " . $newEntityRef->nodeName . "\n";
102    echo "   isConnected: " . ($newEntityRef->isConnected ? 'true' : 'false') . "\n";
103
104    // 3. ノードをドキュメントから削除し、接続が失われた状態にする
105    $rootNew->removeChild($newEntityRef);
106    echo "\n3. ドキュメントから削除後 (接続解除):\n";
107    echo "   ノード名: " . $newEntityRef->nodeName . "\n";
108    echo "   isConnected: " . ($newEntityRef->isConnected ? 'true' : 'false') . "\n";
109    // これは、ネットワーク接続が「失われた」状態に似ています。
110}
111
112// デモンストレーション関数を実行
113demonstrateDomEntityReferenceConnection();

DOMEntityReference::isConnected プロパティは、PHP 8で導入されたDOM拡張機能の一部で、DOMEntityReference クラスに属します。このプロパティは引数を取らず、戻り値としてブール型（bool）の値を返します。trueであれば対象の DOMEntityReference ノードが現在DOMツリーに接続されていることを、falseであれば接続されていないことを示します。

サンプルコードでは、この isConnected プロパティの挙動を二つのパターンで具体的に示しています。一つ目のパターンでは、既存のXMLからエンティティ参照ノードをロードし、そのノードを親要素から削除すると isConnected が false に変化し、再度親に追加すると true に戻る様子を確認できます。これにより、ノードがドキュメントツリーから一時的に切り離されると接続が失われることを理解できます。

二つ目のパターンでは、DOMDocument::createEntityReference メソッドで新しくエンティティ参照ノードを作成する際、その直後にはまだドキュメントツリーに追加されていないため isConnected が false となることを示しています。その後、この新規ノードをドキュメントの親要素に追加すると、isConnected が true に変化し、ドキュメントとの接続が確立された状態になります。再びドキュメントから削除すると false に戻ります。

このように、isConnected プロパティを使用することで、DOMEntityReference ノードがドキュメントの構造の一部として存在しているか、または独立した状態にあるかを正確に判断することが可能です。