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

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

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

基本的な使い方

isConnectedプロパティは、Dom\Textオブジェクトが属するノードツリーに接続されているかどうかを示す読み取り専用のプロパティです。このプロパティは、PHP 8でDom\Textクラスに追加されました。

具体的には、isConnectedプロパティは、Dom\Textオブジェクトがドキュメントに接続されている場合にtrueを、そうでない場合にfalseを返します。ドキュメントに接続されているとは、そのDom\Textオブジェクトが、Dom\Documentオブジェクトをルートとするノードツリーの一部であるということです。

Dom\Textオブジェクトが作成された直後や、removeChildメソッドなどでノードツリーから削除された後では、isConnectedプロパティはfalseを返します。一方、appendChildメソッドやinsertBeforeメソッドなどでノードツリーに追加された後では、trueを返します。

isConnectedプロパティは、Dom\Textオブジェクトの状態を確認し、適切に処理を行うために役立ちます。例えば、ノードツリーに接続されていないDom\Textオブジェクトに対して特定の操作を行うことを防ぐために使用できます。

システムエンジニアを目指す初心者の方にとって、isConnectedプロパティは、DOM (Document Object Model) を理解し、PHPでXMLやHTMLを扱う上で重要な概念です。DOMは、XMLやHTMLドキュメントをツリー構造で表現し、プログラムからドキュメントの内容にアクセスしたり、変更したりするためのAPIを提供します。isConnectedプロパティを利用することで、DOMツリーの状態を正確に把握し、より安全で効率的なコードを作成することができます。

構文(syntax)


1Dom\Text::$isConnected;

引数(parameters)

引数なし

引数はありません

戻り値(return)

bool

Dom\Text::isConnected()は、このテキストノードがDOMツリーに接続されているかどうかを示す真偽値（bool）を返します。接続されていればtrue、そうでなければfalseです。

サンプルコード

PHP Dom\Text::isConnectedで接続確認する


1<?php
2
3/**
4 * Dom\Text::isConnected プロパティの使用例。
5 * このプロパティは、テキストノードがDOMツリーに接続されているかどうか（親ノードを持っているか）を示します。
6 * キーワードの「isconnected」という概念に基づき、DOMノードの接続状態を確認するサンプルです。
7 */
8function demonstrateDomTextIsConnected(): void
9{
10    // 1. 新しいDOMドキュメントを作成します。PHP 8の新しいDomインターフェースを使用。
11    $document = new Dom\Document();
12
13    // 2. 新しいテキストノードを作成しますが、まだDOMツリーには追加しません。
14    $textNode = new Dom\Text('これはテストテキストです。');
15
16    echo "--- ドキュメントに追加する前 ---" . PHP_EOL;
17
18    // 3. テキストノードがDOMツリーに接続されているか確認します。
19    // まだどこにも追加されていないため、false が返されるはずです。
20    echo "テキストノードはドキュメントに接続されていますか？ " . ($textNode->isConnected ? 'はい' : 'いいえ') . PHP_EOL;
21
22    // 4. ドキュメントのルート要素（例えば <body>）を作成し、ドキュメントに追加します。
23    $bodyElement = new Dom\Element('body');
24    $document->appendChild($bodyElement);
25
26    // 5. テキストノードをbody要素の子として追加し、DOMツリーに接続します。
27    $bodyElement->appendChild($textNode);
28
29    echo PHP_EOL . "--- ドキュメントに追加した後 ---" . PHP_EOL;
30
31    // 6. テキストノードがDOMツリーに接続されているか再度確認します。
32    // body要素の子として追加されたため、true が返されるはずです。
33    echo "テキストノードはドキュメントに接続されていますか？ " . ($textNode->isConnected ? 'はい' : 'いいえ') . PHP_EOL;
34
35    echo PHP_EOL . "--- ドキュメントの現在のXML内容（参考） ---" . PHP_EOL;
36    // ドキュメントの内容をXML形式で出力し、テキストノードが追加されたことを確認します。
37    echo $document->saveXML();
38}
39
40// 上記の関数を実行して、Dom\Text::isConnected の動作を確認します。
41demonstrateDomTextIsConnected();

Dom\Text::isConnected プロパティは、PHP 8のDOM拡張機能におけるDom\Textクラスのプロパティです。このプロパティは、テキストノードがドキュメントオブジェクトモデル（DOM）ツリーの一部として接続されているかどうかを真偽値（bool）で返します。引数は必要ありません。

trueが返される場合、そのテキストノードは親ノードを持ち、DOMツリーに正常に組み込まれています。一方、falseが返される場合は、ノードが単独で存在しており、まだDOMツリーに属していない状態です。

サンプルコードでは、まず作成したテキストノードをドキュメントに追加する前の段階でisConnectedプロパティを確認し、未接続状態を示すfalseが出力されます。その後、テキストノードをドキュメント内の<body>要素の子として追加し、ツリーに接続された状態で再度isConnectedプロパティを確認すると、trueが出力されることが示されています。

このプロパティは、Paho MQTTなどのライブラリで接続状態（isconnected）を確認するのと同様に、特定のリソースやオブジェクトがそのシステムのコンテキスト内で有効な状態にあるかを判断する際に役立ちます。DOMツリー内のノードの所属状態を正確に把握するために利用されます。

Dom\Text::isConnectedプロパティは、PHP 8から利用できる新しいDOMインターフェースの機能です。このプロパティは、テキストノードが親ノードに正しく追加され、DOMツリーに現在接続されているかを示す真偽値を返します。ノードをただ生成しただけではfalseを返し、appendChildなどのDOM操作によってツリーに追加されて初めてtrueを返しますので、ノードの作成とDOMツリーへの追加のタイミングを理解することが重要です。また、$node->isConnectedのようにメソッドではなくプロパティとして直接参照する点にも注意が必要です。この特性を把握することで、DOMツリーの状態を正確に確認し、意図しないエラーを防ぐことができます。

Paho接続喪失時、Dom\Text::isConnectedで接続状態を確認する


1<?php
2
3/**
4 * Paho接続喪失という状況を想定し、そのメッセージをDOMツリーに
5 * 追加する際のDom\Textノードの接続状態を確認するサンプルです。
6 *
7 * Dom\Text::isConnected は、テキストノードがDOMドキュメントツリーに
8 * 接続されているか（親ノードを持っているか）を示すブール値プロパティです。
9 * Pahoクライアントの「connection lost」イベント発生時に、
10 * ユーザーインターフェース（DOM）にその状態を表示するシナリオを想定しています。
11 */
12function handlePahoConnectionStatusDisplay(): void
13{
14    // 新しいDOMドキュメントを作成します。これはウェブページ全体を模倣します。
15    $document = new DOMDocument();
16
17    // ドキュメントのルート要素として<body>を追加します。
18    // ノードはドキュメントに追加されることで「接続」されます。
19    $body = $document->createElement('body');
20    $document->appendChild($body);
21
22    // Pahoの接続状態を表示するためのコンテナ要素（例: <div>）を作成し、<body>に追加します。
23    $statusContainer = $document->createElement('div');
24    $statusContainer->setAttribute('id', 'paho-status');
25    $body->appendChild($statusContainer);
26
27    // Paho接続が失われたことを示すテキストノードを作成します。
28    // この時点では、まだDOMツリーのどの要素にも追加されていません。
29    $connectionLostText = new Dom\Text("Paho connection lost!");
30
31    // テキストノードがDOMツリーに接続されているか確認します。
32    // まだ親ノードがないため、'false'が返されるはずです。
33    echo "テキストノード '{$connectionLostText->data}' はDOMに接続されていますか？ "
34         . ($connectionLostText->isConnected ? 'はい' : 'いいえ') . "\n";
35
36    // テキストノードをコンテナ要素に追加し、DOMツリーに接続します。
37    $statusContainer->appendChild($connectionLostText);
38
39    // テキストノードがDOMツリーに接続されたことを再度確認します。
40    // 親ノード（$statusContainer）ができたため、'true'が返されるはずです。
41    echo "テキストノード '{$connectionLostText->data}' はDOMに接続されていますか？ "
42         . ($connectionLostText->isConnected ? 'はい' : 'いいえ') . "\n";
43
44    // (オプション) 生成されたHTMLを出力して、DOMツリーの状態を確認できます。
45    // echo "\n--- 生成されたHTML ---\n";
46    // echo $document->saveHTML();
47}
48
49// サンプル関数を実行します。
50handlePahoConnectionStatusDisplay();
51

Dom\Text::isConnectedプロパティは、PHPのDOM操作において、テキストノードが現在DOMドキュメントツリーに「接続されているか」どうかを示す真偽値（bool）を返します。このプロパティに引数はありません。テキストノードが親ノードを持っている場合にtrueを返し、まだどの要素にも追加されていない場合はfalseを返します。

このサンプルコードでは、Pahoクライアントの接続が失われた状況を想定し、そのメッセージをウェブページ（DOMツリー）に表示するシナリオでisConnectedプロパティの動作を確認します。まず、新しいDOMドキュメントと<body>要素を作成し、ステータス表示用のdiv要素を追加します。次に「Paho connection lost!」というテキストノードを単独で作成します。この時点では、テキストノードはまだDOMツリーのどの要素にも追加されていないため、isConnectedプロパティはfalseと表示されます。

その後、作成したテキストノードを、先に準備したdiv要素の子ノードとして追加します。これにより、テキストノードはDOMツリーに接続され、親ノードを持つ状態になります。再度isConnectedプロパティを確認すると、今度はtrueと表示され、ノードがツリーに接続されたことが分かります。このプロパティは、ノードの操作を行う際に、そのノードが既にドキュメントの一部となっているかを確認したい場合に有用です。

Dom\Text::isConnectedプロパティは、テキストノードが実際にDOMツリー内の親ノードに追加され、接続が確立された後にtrueとなります。テキストノードを単に作成しただけでは、まだ親ノードがないためfalseが返される点にご注意ください。

このプロパティは、動的に生成したコンテンツがウェブページに正しく表示される状態にあるかを確認する際に役立ちます。サンプルコードのように、Pahoの接続状態変化といった特定のイベントに応じて、プログラムがユーザーインターフェースを適切に更新したかどうかの検証に利用できます。PHPのDOM拡張機能は、HTMLやXMLドキュメントをプログラムで操作するための基盤ですので、基本的な操作とノードの状態遷移を理解することが重要です。