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

Copy
1<?php
2
3/**
4 * DOMNode::isConnected プロパティの動作をシステムエンジニアを目指す初心者向けに示します。
5 *
6 * DOMNode::isConnected は、DOMノードがDOMDocumentのツリーに接続されているかどうかを示すブール値のプロパティです。
7 * ツリーに接続されている場合（つまり、親ノードを持っている場合）、true を返します。
8 * 独立したノードである場合（まだドキュメントに追加されていない、またはドキュメントから削除された場合）、false を返します。
9 */
10function demonstrateDomNodeIsConnected(): void
11{
12    // ① 新しいDOMドキュメントを作成します。HTMLやXMLを解析・操作するために使われます。
13    $document = new DOMDocument();
14    // 簡単なHTMLコンテンツをロードします。これにより、DOMツリーが構築されます。
15    // ロードされた要素は、当然ながらドキュメントに「接続」されています。
16    $document->loadHTML('<div id="root"><span id="child">既存の子要素</span></div>');
17
18    // ② ドキュメント内の既存のノードを取得します。
19    // これらのノードはドキュメントの一部なので、isConnected は true になるはずです。
20    $rootElement = $document->getElementById('root');
21    $childElement = $document->getElementById('child');
22
23    // ③ 新しいDOM要素を作成します。
24    // この時点では、まだどのドキュメントにも追加されていないため、独立したノードです。
25    $newNode = $document->createElement('p', 'これは新しく作成された段落です。');
26
27    // ④ ノードの接続状態を初期状態で確認し、出力します。
28    echo "--- ノード追加前 ---\n";
29    echo "Root element (id='root') is connected: " . ($rootElement->isConnected ? 'Yes' : 'No') . "\n";
30    echo "Child element (id='child') is connected: " . ($childElement->isConnected ? 'Yes' : 'No') . "\n";
31    // 新しく作成された$newNodeはまだドキュメントに追加されていないため、isConnected は false です。
32    echo "New node ('<p>') is connected: " . ($newNode->isConnected ? 'Yes' : 'No') . "\n";
33
34    // ⑤ 新しいノードをドキュメント内の既存の要素に追加します。
35    // これにより、$newNodeはDOMツリーの一部となり、「接続」されます。
36    if ($rootElement instanceof DOMElement) {
37        $rootElement->appendChild($newNode);
38        echo "\n新しいノードを #root 要素に追加しました。\n";
39    } else {
40        echo "\nエラー: #root 要素が見つからなかったため、ノードを追加できませんでした。\n";
41        return;
42    }
43
44    // ⑥ ノードをドキュメントに追加した後の接続状態を再度確認します。
45    echo "\n--- ノード追加後 ---\n";
46    echo "Root element (id='root') is connected: " . ($rootElement->isConnected ? 'Yes' : 'No') . "\n";
47    echo "Child element (id='child') is connected: " . ($childElement->isConnected ? 'Yes' : 'No') . "\n";
48    // $newNodeは$rootElementの子としてドキュメントに追加されたため、isConnected は true に変わります。
49    echo "New node ('<p>') is connected: " . ($newNode->isConnected ? 'Yes' : 'No') . "\n";
50
51    // ⑦ ドキュメントからノードを削除した場合の接続状態を確認します。
52    // 削除されたノードは再びドキュメントから切り離されるため、isConnected は false に戻ります。
53    if ($rootElement->contains($newNode)) { // PHP 8で追加されたcontains()でノードが含まれているか確認
54        $removedNode = $rootElement->removeChild($newNode);
55        echo "\n#root 要素から新しいノードを削除しました。\n";
56        echo "\n--- ノード削除後 ---\n";
57        // removedNodeは$newNodeと同じオブジェクトを参照しており、ドキュメントから削除されたため false です。
58        echo "Removed node ('<p>') is connected: " . ($removedNode->isConnected ? 'Yes' : 'No') . "\n";
59        // $newNode変数も、同じオブジェクトを参照しているのでisConnectedはfalseになります。
60        echo "New node variable (now removed) is connected: " . ($newNode->isConnected ? 'Yes' : 'No') . "\n";
61    }
62}
63
64// 上記のサンプル関数を実行します。
65demonstrateDomNodeIsConnected();

PHP 8のDOMNode::isConnectedプロパティは、HTMLやXMLを操作するDOMツリーにおいて、特定のノードがドキュメントの構造に接続されているかを確認するために使用されます。このプロパティは引数を取らず、ノードがDOMDocumentオブジェクトの階層構造の一部である場合にtrueを、そうでない場合にfalseを真偽値として返します。

具体的には、ノードが親ノードを持ち、ドキュメントツリーに組み込まれている状態であればtrueとなります。一方、まだドキュメントに追加されていない独立したノードや、一度ドキュメントに追加された後に削除されたノードの場合はfalseとなります。

サンプルコードでは、まず新しく作成した<p>タグのノードは、まだどのドキュメントにも追加されていないためisConnectedがfalseと表示されます。次に、このノードを既存の<div>要素の子として追加すると、ドキュメントツリーの一部となるためisConnectedの値がtrueに変化します。さらに、一度追加したノードを削除すると、そのノードはドキュメントから切り離されるためisConnectedは再びfalseに戻ることを確認できます。このプロパティは、DOMを動的に操作する際のノードの状態確認に役立ちます。

Copy
1<?php
2
3/**
4 * DOMNode::isConnected プロパティの使用方法をデモンストレーションします。
5 * このプロパティは、DOMノードがDOMツリーに接続されているか（ドキュメントの一部であるか）を確認します。
6 * (注: この「接続」はDOMツリー内の状態を指し、ネットワーク接続の状態とは異なります。)
7 *
8 * システムエンジニアを目指す初心者の方へ:
9 * DOM (Document Object Model) は、HTMLやXMLドキュメントをプログラムから操作するためのAPIです。
10 * DOMツリーとは、ドキュメントの構造を木のように表現したものです。
11 * isConnected は、その木のどこかにこのノードが存在しているかを教えてくれます。
12 */
13function demonstrateDomNodeConnection(): void
14{
15    // 1. DOMDocument オブジェクトを作成します。これはDOMツリーの根となるドキュメントです。
16    $dom = new DOMDocument('1.0', 'UTF-8');
17
18    // 2. ルート要素を作成し、ドキュメントに追加します。
19    //    この時点ではまだ追加されていません。
20    $rootElement = $dom->createElement('root');
21
22    // 2.1 作成直後の要素の接続状態を確認します。
23    //     まだドキュメントに追加されていないため、isConnected は false です。
24    echo "1. ルート要素 'root' はドキュメントに接続されていますか？ (作成直後): "
25         . ($rootElement->isConnected ? 'はい' : 'いいえ') . "\n";
26
27    // 2.2 ルート要素をドキュメントに実際に接続します。
28    $dom->appendChild($rootElement);
29
30    // 2.3 ドキュメントに追加された後の要素の接続状態を確認します。
31    //     これで isConnected は true になります。
32    echo "2. ルート要素 'root' はドキュメントに接続されていますか？ (追加後): "
33         . ($rootElement->isConnected ? 'はい' : 'いいえ') . "\n";
34
35    // 3. 子要素を作成し、その接続状態を確認します。
36    $childElement = $dom->createElement('child');
37
38    // 3.1 作成直後の子要素はドキュメントに接続されていません。
39    echo "3. 子要素 'child' はドキュメントに接続されていますか？ (作成直後): "
40         . ($childElement->isConnected ? 'はい' : 'いいえ') . "\n";
41
42    // 3.2 子要素をルート要素に追加します。これでドキュメントツリーに接続されます。
43    $rootElement->appendChild($childElement);
44
45    // 3.3 追加後の子要素の接続状態を確認します。
46    //     これで isConnected は true になります。
47    echo "4. 子要素 'child' はドキュメントに接続されていますか？ (追加後): "
48         . ($childElement->isConnected ? 'はい' : 'いいえ') . "\n";
49
50    // 4. 子要素をドキュメントから削除（切断）します。
51    $rootElement->removeChild($childElement);
52
53    // 4.1 削除後の子要素の接続状態を確認します。
54    //     ドキュメントから切り離されたため、isConnected は false に戻ります。
55    echo "5. 子要素 'child' はドキュメントに接続されていますか？ (削除後): "
56         . ($childElement->isConnected ? 'はい' : 'いいえ') . "\n";
57}
58
59// 関数を実行して結果を表示します。
60demonstrateDomNodeConnection();

PHP 8のDOMNode::isConnectedプロパティは、特定のDOMノードが現在のDOM (Document Object Model) ツリーに接続されているか否かを示す真偽値（bool）を返します。この「接続」とは、ノードがHTMLやXMLなどのドキュメント構造の一部として存在している状態を指し、ネットワーク接続の状態とは異なります。このプロパティに引数はなく、ノードがドキュメントツリーに接続されていればtrueを、そうでなければfalseを戻り値として返します。

サンプルコードでは、まずDOMDocumentを作成し、新しい要素を生成する流れを通じてisConnectedの挙動を示しています。要素を生成した直後は、まだどのドキュメントにも追加されていないため、isConnectedはfalseとなります。その要素をDOMDocumentや他の親ノードに追加すると、ノードはDOMツリーの一部となるため、isConnectedはtrueに変化します。さらに、ツリーからそのノードを削除すると、再びisConnectedはfalseに戻ります。このように、isConnectedプロパティは、DOMツリー内におけるノードの現在の所属状態を簡潔に確認するために利用されます。