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

isConnectedプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年11月06日

基本的な使い方

isConnectedプロパティは、Dom\HTMLDocumentオブジェクトがDOMツリーに接続されているかどうかの状態を示すブール値を保持するプロパティです。このプロパティは、HTMLドキュメントノードが完全に構築されたDOMツリーの一部である場合にtrueを、どのドキュメントツリーにも属していない独立した状態である場合にfalseを保持します。

システムエンジニアを目指す初心者の方にとって、このプロパティは、HTMLドキュメントオブジェクトが実際に操作可能なDOM構造に組み込まれているかを判断する上で重要です。例えば、new Dom\HTMLDocument()で新たにオブジェクトを作成した直後で、まだHTMLコンテンツが読み込まれていない、または他の既存のDOMツリーに挿入されていない初期状態では、isConnectedプロパティはfalseを保持します。一方で、loadHTML()メソッドなどでHTMLコンテンツがパースされ、そのドキュメントノードが自身のルートノードとして、または他のドキュメントにインポートされるなどして、完全に機能するDOMツリーの一部となった場合には、trueを保持するようになります。

このプロパティを利用することで、ドキュメントの状態を正確に把握し、その後の要素の追加や変更といったDOM操作を行う前に、ドキュメントが適切に準備されているかを確認することができます。これにより、未接続状態のドキュメントに対する無意味な操作や、それに起因するエラーを防ぎ、より堅牢なプログラムを作成するのに役立ちます。

構文(syntax)


1<?php
2
3$document = new Dom\HTMLDocument();
4$isConnected = $document->isConnected;

引数(parameters)

引数なし

引数はありません

戻り値(return)

bool

Dom\HTMLDocument::isConnected は、HTMLドキュメントが現在アクティブな接続を持っているかどうかを示す真偽値 (bool) を返します。

サンプルコード

PHP Dom\HTMLDocument::isConnected で要素の接続状態を確認する


1<?php
2
3/**
4 * Dom\HTMLDocument::isConnected プロパティの使用例を示します。
5 *
6 * このプロパティは、HTML要素がDOM (Document Object Model) ツリーに
7 * 接続されているか（つまり、ウェブページの一部として存在するか）を真偽値で返します。
8 *
9 * 注意: このプロパティは、Paho MQTTなどのネットワーク接続の状態とは異なります。
10 * ここでの「接続」は、要素がドキュメント構造内に存在するかどうかを意味します。
11 */
12function demonstrateDomIsConnected(): void
13{
14    // 1. 新しいHTMLドキュメントオブジェクトを作成します。
15    //    このドキュメント自体は、常に「接続済み」と見なされます。
16    $document = new Dom\HTMLDocument();
17    echo "新しいドキュメントの isConnected: " . ($document->isConnected ? "true" : "false") . PHP_EOL; // 結果: true
18
19    // 2. HTMLコンテンツをドキュメントにロードします。
20    //    ロードされたHTML内の要素は、ドキュメントツリーに接続されています。
21    $document->loadHTML('<!DOCTYPE html><html><body><p id="existing-paragraph">既存の段落</p></body></html>');
22
23    // 3. ドキュメント内の既存の要素を取得し、その接続状態を確認します。
24    //    この要素はすでにドキュメントツリーの一部なので、「接続済み」です。
25    $existingParagraph = $document->getElementById('existing-paragraph');
26    if ($existingParagraph) {
27        echo "既存の段落要素の isConnected: " . ($existingParagraph->isConnected ? "true" : "false") . PHP_EOL; // 結果: true
28    }
29
30    // 4. 新しい要素を作成しますが、まだドキュメントには追加しません。
31    //    この時点では、要素はDOMツリーに属していないため、「未接続」です。
32    $newDivElement = $document->createElement('div');
33    echo "新しいdiv要素 (未追加) の isConnected: " . ($newDivElement->isConnected ? "true" : "false") . PHP_EOL; // 結果: false
34
35    // 5. 新しい要素をドキュメントのbodyに追加します。
36    //    これで要素はDOMツリーに「接続」されます。
37    $document->body?->appendChild($newDivElement);
38    echo "新しいdiv要素 (追加後) の isConnected: " . ($newDivElement->isConnected ? "true" : "false") . PHP_EOL; // 結果: true
39
40    // 6. 別の新しい要素を作成し、ドキュメントに追加しないまま状態を確認します。
41    //    これは、追加されていない要素が「未接続」であることを再度示します。
42    $anotherNewElement = $document->createElement('span');
43    echo "別の新しいspan要素 (未追加) の isConnected: " . ($anotherNewElement->isConnected ? "true" : "false") . PHP_EOL; // 結果: false
44}
45
46// 関数を実行して、Dom\HTMLDocument::isConnected プロパティの動作を確認します。
47demonstrateDomIsConnected();

PHPのDom\HTMLDocument::isConnectedプロパティは、HTML要素がウェブページの構造（DOMツリー）に実際に存在しているか、つまり「接続」されているかを真偽値で確認するために使用されます。この「接続」は、Paho MQTTなどのネットワーク接続とは異なり、あくまでHTMLドキュメント内部での要素の所属状態を指します。

このプロパティに引数はなく、戻り値としてbool型を返します。trueであれば要素はドキュメントツリーの一部として存在しており、falseであればまだドキュメントに追加されていない、独立した状態であることを示します。

サンプルコードでは、まず新しいHTMLDocumentオブジェクトを作成すると、それ自体は常に「接続済み」としてtrueを返します。次に、loadHTMLメソッドで既存のHTMLを読み込むと、その中の要素もドキュメントツリーに属しているためtrueとなります。

一方で、createElementメソッドで新しく要素を作成した直後は、まだドキュメントに追加されていないためfalseが返されます。その後、appendChildなどの方法でその要素をドキュメントのボディ部分に追加すると、要素がDOMツリーに組み込まれるため、isConnectedはtrueに変化します。このように、isConnectedプロパティは要素がドキュメントのどの段階にあるかを確認する際に役立ちます。

isConnectedプロパティは、HTML要素がウェブページの構造（DOMツリー）に組み込まれているかを確認するものです。ネットワーク接続（Paho MQTTのような）の状態とは異なりますので、混同しないよう注意してください。新しく作成した要素は、ドキュメントにまだ追加されていない状態では「未接続（false）」です。appendChildなどでドキュメントツリーに追加された後に「接続済み（true）」となります。Dom\HTMLDocumentオブジェクト自体は常に「接続済み」として扱われます。このプロパティは、要素が実際にドキュメント内に存在し、操作可能であるかを判断する際に役立ちます。

Dom\HTMLDocument::isConnected による接続状態確認


1<?php
2
3/**
4 * Dom\HTMLDocument::isConnected プロパティの動作と、
5 * 「paho connection lost」の概念を抽象的に関連付けるサンプルコードです。
6 *
7 * Dom\HTMLDocument::isConnected はDOMツリー内のノードがドキュメントに「接続されている」かを示します。
8 * キーワード「paho connection lost」は外部ネットワーク接続の喪失を指しますが、
9 * ここでは「何かが利用可能か（接続されているか）」という抽象的なチェックとして関連付けます。
10 * 外部接続が失われた状況下で、DOMツリーが適切に構築されたか、
11 * あるいは特定のDOM要素が「接続されている」状態にあるかを検証するシナリオを想定します。
12 */
13function checkDomConnectionStatusForLostConnectionScenario(): void
14{
15    echo "--- Dom\\HTMLDocument::isConnected のデモンストレーション ---" . PHP_EOL;
16    echo "Dom\\HTMLDocument::isConnected は、DOMノードがHTMLドキュメントツリーに属しているかを示します。" . PHP_EOL;
17    echo "外部ネットワークの接続状態とは直接関係ありませんが、" . PHP_EOL;
18    echo "「何かが利用可能か」という抽象的な概念としてキーワードと関連付けています。" . PHP_EOL;
19    echo PHP_EOL;
20
21    // 1. 基本的なHTMLドキュメントを作成
22    // Dom\HTMLDocument オブジェクト自体は、PHPスクリプト内で生成された時点で
23    // 自身のルートとして「接続されている」と見なされます。
24    // これは、外部との「接続が確立している」状態に対応すると抽象的に解釈できます。
25    $htmlContent = '<!DOCTYPE html><html><head><title>Connection Status</title></head><body><div id="app-status">Application is running.</div></body></html>';
26    $document = new Dom\HTMLDocument();
27    $document->loadHTML($htmlContent);
28
29    echo "1. HTMLDocumentオブジェクトはPHP環境に接続済み: " . ($document->isConnected ? "true" : "false") . PHP_EOL;
30
31    // 2. ドキュメント内の既存要素の接続状態を確認
32    // アプリケーションの状態を示す要素がドキュメントに「接続されている」か確認します。
33    $appStatusElement = $document->getElementById('app-status');
34    if ($appStatusElement) {
35        echo "2. 'app-status'要素はドキュメントに接続済み: " . ($appStatusElement->isConnected ? "true" : "false") . PHP_EOL;
36    } else {
37        echo "2. 'app-status'要素が見つかりません。" . PHP_EOL;
38    }
39
40    echo PHP_EOL;
41    echo "--- ここから「接続ロスト」のシナリオを抽象的に表現 ---" . PHP_EOL;
42
43    // 3. 外部からのデータ取得に失敗した（「paho connection lost」のような状況）と仮定し、
44    // それによってHTMLの構築が不完全になる、または特定の要素が追加されないシナリオ。
45    // 新しいHTMLドキュメント（エラー状態を想定）を作成します。
46    $documentWithError = new Dom\HTMLDocument();
47    // 外部接続の喪失をシミュレートし、HTMLがロードできない、または不完全な状態とする
48    // Dom\HTMLDocumentオブジェクト自体はPHPスクリプト内で生成されているため、
49    // この場合でもisConnected は true を返します。これは、DOMオブジェクト自体は存在していることを意味します。
50    $documentWithError->loadHTML('<!DOCTYPE html><html><body><p>Initial state: Waiting for external data.</p></body></html>');
51    
52    echo "3. エラー状態のHTMLDocumentオブジェクトはPHP環境に接続済み: " . ($documentWithError->isConnected ? "true" : "false") . PHP_EOL;
53
54    // 4. エラー処理用の要素を作成するが、まだドキュメントには追加しない。
55    // 新しく作成された要素は、まだドキュメントツリーに「接続されていない」ため isConnected は false です。
56    // これは、外部からの情報がまだDOMに「反映されていない」状態を表します。
57    $errorMessageDiv = $documentWithError->createElement('div', 'Connection to external service lost!');
58    $errorMessageDiv->setAttribute('id', 'connection-lost-message');
59    echo "4. 新しいエラー要素はドキュメントに未接続: " . ($errorMessageDiv->isConnected ? "true" : "false") . PHP_EOL;
60
61    // 5. 外部接続が失われた状況をUIに反映するため、エラーメッセージ要素をドキュメントに追加。
62    // これにより、要素がドキュメントツリーに「接続」され、UIに表示可能になります。
63    $bodyWithError = $documentWithError->getElementsByTagName('body')->item(0);
64    if ($bodyWithError) {
65        $bodyWithError->appendChild($errorMessageDiv);
66        echo "5. エラー要素をドキュメントに追加後、接続済み: " . ($errorMessageDiv->isConnected ? "true" : "false") . PHP_EOL;
67    } else {
68        echo "5. body要素が見つからないため、エラー要素を追加できませんでした。" . PHP_EOL;
69    }
70
71    echo PHP_EOL;
72    echo "--- 現在のエラーHTMLドキュメントの状態 ---" . PHP_EOL;
73    echo $documentWithError->saveHTML();
74}
75
76// 関数の実行
77checkDomConnectionStatusForLostConnectionScenario();

PHP 8のDom\HTMLDocument::isConnectedプロパティは、HTMLドキュメント内のノードが現在DOMツリーに「接続されている」状態にあるかどうかを判定します。このプロパティは引数を取らず、戻り値としてブール値（trueまたはfalse）を返します。

ここでいう「接続されている」とは、そのDOMノードがHTMLドキュメントの構造の一部として組み込まれ、有効な状態にあることを意味します。例えば、new Dom\HTMLDocument()で作成されたドキュメントオブジェクト自体や、loadHTML()メソッドで読み込まれた既存のHTML要素は、通常trueを返します。一方、createElement()などで新しく作成された要素は、まだドキュメントツリーに組み込まれていない状態ではfalseを返しますが、appendChild()などのメソッドでドキュメントツリーに追加されるとtrueに変わります。

キーワードである「paho connection lost」は外部ネットワーク接続の喪失を指しますが、このisConnectedプロパティはDOMツリー内部の状態を示すため、外部接続とは直接関係ありません。しかし、「何かが利用可能か」「特定の要素がシステム（DOMツリー）に組み込まれているか」という抽象的な「接続状態」として解釈できます。外部接続が失われた状況を想定し、その際にエラーメッセージを表示するためのDOM要素がドキュメントに「接続されている」かを確認することで、アプリケーションがユーザーに対して適切に情報を提示できる状態にあるかを判断する際に利用できます。これにより、動的なコンテンツ更新やエラーハンドリングのロジックをより確実に実装できます。

Dom\HTMLDocument::isConnectedプロパティは、DOMノードがHTMLドキュメントツリーに属しているかを示します。これは外部ネットワークの接続状態とは直接関係がありません。サンプルコードでは「paho connection lost」というキーワードとの関連付けがありますが、これは本プロパティの機能を抽象的に例示するものであり、初心者がネットワーク接続の確認と混同しないよう特に注意が必要です。

このプロパティを使用する際、Dom\HTMLDocumentオブジェクト自体は、PHPスクリプト内で生成された時点でisConnectedが常にtrueを返します。しかし、createElementなどで新しく作成された要素は、ドキュメントツリーにappendChildなどで追加されるまでfalseとなります。これらの挙動の違いを理解し、DOM操作に活用することが重要です。