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

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

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

基本的な使い方

isConnectedプロパティは、PHPのDOM拡張機能におけるDom\CharacterDataクラスのインスタンスが、DOMツリーに現在接続されているかどうかを示す真偽値（boolean）を保持するプロパティです。

Dom\CharacterDataは、DOM（Document Object Model）における文字データを持つノード、例えばテキストノードやコメントノード、CDATAセクションノードなどの基底クラスです。ウェブページやXMLドキュメントの構造は、ノードと呼ばれる要素が親子関係でつながった木構造（DOMツリー）として表現され、PHPのDOM拡張機能を通じてこれらのノードを操作できます。

このisConnectedプロパティの値がtrueの場合、対象のDom\CharacterDataノードは現在、ドキュメントのDOMツリーに組み込まれており、そのドキュメントの一部として機能している状態であることを示します。例えば、何らかのHTML要素の子ノードとして配置されている場合などです。

一方、値がfalseの場合、そのノードはDOMツリーから切り離されています。これは、ノードがnew Dom\Text('hogehoge')のように新しく作成されたばかりで、まだappendChild()などのメソッドを使ってツリーに追加されていない状態や、すでにremoveChild()などのメソッドによってツリーから削除された後の状態などを意味します。

isConnectedプロパティは、ノードを操作する前にそれがドキュメント内に「生きた」状態で存在するかどうかを確認する際に非常に役立ちます。例えば、削除されたノードに対してさらに子ノードを追加しようとしたり、その内容を変更しようとしたりする予期せぬエラーを防ぐために利用できます。これにより、より堅牢なDOM操作のロジックを構築することが可能になります。

構文(syntax)


1<?php
2
3$document = new Dom\Document();
4$textNode = $document->createTextNode('Example text');
5
6$isConnected = $textNode->isConnected;
7
8?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

戻り値なし

戻り値はありません

サンプルコード

PHP Dom isConnected でDOM接続状態を確認する


1<?php
2
3/**
4 * Dom\CharacterData::isConnected プロパティ（実際は Dom\Node::isConnected() メソッド）のサンプルコード。
5 *
6 * このメソッドは、DOMノードがDOMツリーに接続されているかどうかを確認します。
7 * つまり、ドキュメントに属しているかどうかを判断します。
8 *
9 * 注釈: 提供されたリファレンス情報では「戻り値: 戻り値なし」とありますが、
10 * PHPの公式ドキュメントでは Dom\Node::isConnected() は boolean を返します。
11 * このサンプルコードでは、公式ドキュメントに基づき boolean を返すものとして扱います。
12 * （Dom\CharacterData は Dom\Node を継承しています。）
13 */
14
15// 1. DOMDocument オブジェクトを作成
16//    これにより、HTMLやXMLのようなドキュメント構造を操作できます。
17$dom = new DOMDocument();
18
19// 2. 基本的なHTML構造を読み込む
20//    これにより、操作するためのドキュメントツリーが作成されます。
21$dom->loadHTML('<!DOCTYPE html><html><body><div id="container"></div></body></html>');
22
23// 3. テキストノードを作成
24//    Dom\CharacterData を継承するノードの一つであるテキストノードを作成します。
25//    この時点では、まだDOMツリーには追加されていません。
26$textNode = $dom->createTextNode('これはDOMツリーに追加されるテキストです。');
27
28// 4. まだDOMツリーに追加されていないノードの状態を確認
29echo "--- DOMツリーに追加する前 ---\n";
30echo "テキストノードは接続されていますか？ " . ($textNode->isConnected() ? 'はい' : 'いいえ') . "\n\n";
31// 期待される出力: いいえ
32
33// 5. ノードをDOMツリーに追加
34//    getElementById メソッドで既存の要素（ここでは id="container" のdiv）を取得し、
35//    appendChild メソッドで作成したテキストノードを追加します。
36$container = $dom->getElementById('container');
37if ($container) {
38    $container->appendChild($textNode);
39    echo "テキストノードを 'container' 要素に追加しました。\n";
40} else {
41    echo "エラー: 'container' 要素が見つかりませんでした。\n";
42}
43
44// 6. DOMツリーに追加された後のノードの状態を確認
45echo "\n--- DOMツリーに追加した後 ---\n";
46echo "テキストノードは接続されていますか？ " . ($textNode->isConnected() ? 'はい' : 'いいえ') . "\n\n";
47// 期待される出力: はい
48
49// 7. 別途、まだDOMツリーに追加されていないコメントノードの例
50$commentNode = $dom->createComment('これはまだ接続されていないコメントです。');
51echo "--- 別のノードの例 (未接続) ---\n";
52echo "コメントノードは接続されていますか？ " . ($commentNode->isConnected() ? 'はい' : 'いいえ') . "\n";
53// 期待される出力: いいえ

Dom\CharacterData::isConnected は、PHPのDOM操作において、特定のノードが現在DOMツリーに接続されているかどうか、つまりドキュメントに属しているかどうかを調べるためのメソッドです。このメソッドは引数を取らず、ノードがDOMツリーに接続されていれば true、接続されていなければ false の真偽値（boolean）を返します。

サンプルコードでは、まず DOMDocument オブジェクトを作成し、基本的なHTML構造を読み込みます。次に createTextNode を使用してテキストノードを作成しますが、この時点ではまだノードはDOMツリーのどこにも追加されていません。この未接続の状態で isConnected() を呼び出すと false が返されることを確認できます。

その後、getElementById で既存の要素（この例では id="container" の div）を取得し、appendChild メソッドを使って作成したテキストノードをその要素の子として追加します。この操作によってテキストノードはDOMツリーに組み込まれ、ドキュメントの一部となります。再び isConnected() を呼び出すと true が返され、ノードが接続されたことが確認できます。

同様に、まだDOMツリーに追加されていないコメントノードの例でも、isConnected() は false を返します。このように、isConnected() メソッドは、DOMノードがドキュメント内で有効な位置にあるかをプログラム的に確認する際に役立ちます。

このサンプルコードは、DOMノードがDOMツリーに接続されているかを確認するisConnected()メソッドを示しています。提供されたリファレンス情報では「戻り値なし」とありますが、実際のPHPのDom\Node::isConnected()メソッドは真偽値（boolean）を返します。また、リファレンスでは「プロパティ」と記載されていますが、これはメソッドとして動作します。Dom\CharacterDataクラスはDom\Nodeを継承しているため、このメソッドが利用可能です。ノードが「接続されている」とは、DOMDocumentによって構築されたドキュメントツリーに実際に追加されている状態を指します。ノードを作成しただけでは未接続であり、appendChild()などでツリーに追加することで接続状態になります。この挙動を理解し、正しい戻り値の型で処理することが重要です。

PHP: DomNode::isConnected で接続状態を確認する


1<?php
2
3/**
4 * DOMノードの接続状態をデモンストレーションする関数。
5 * Dom\CharacterDataクラスはDom\Nodeを継承しており、isConnected()メソッドを利用できます。
6 * このメソッドは、ノードがドキュメントツリーに接続されているかどうかをチェックし、
7 * ネットワーク接続の喪失（"paho connection lost"）と同様に、
8 * 要素がそのコンテキストから「切断」される状況の概念を示します。
9 *
10 * @see https://www.php.net/manual/ja/domnode.isconnected.php PHP公式ドキュメント: Dom\Node::isConnected
11 */
12function demonstrateDomConnectionStatus(): void
13{
14    // 1. 新しいDOMドキュメントを作成し、ルート要素を追加
15    $dom = new Dom\Document('1.0', 'UTF-8');
16    $root = $dom->createElement('root');
17    $dom->appendChild($root);
18
19    // 2. Dom\CharacterDataのインスタンスであるテキストノードを作成
20    // Dom\TextはDom\CharacterDataを継承しています。
21    $textNode = $dom->createTextNode('これはテストテキストです。');
22
23    echo "--- DOMノードの接続状態デモンストレーション ---\n";
24
25    // 3. ノードがドキュメントに接続される前の状態を確認
26    // isConnected()は、ノードがドキュメントツリーに属している場合にtrueを返します。
27    // まだツリーにないため、'いいえ' を返すはずです。
28    echo "ノード追加前: ドキュメントに接続されていますか？ " . ($textNode->isConnected() ? 'はい' : 'いいえ') . "\n";
29
30    // 4. テキストノードをルート要素の子としてドキュメントツリーに追加
31    $root->appendChild($textNode);
32
33    // 5. ノードがドキュメントに接続された後の状態を確認
34    // ドキュメントツリーの一部になったため、'はい' を返すはずです。
35    echo "ノード追加後: ドキュメントに接続されていますか？ " . ($textNode->isConnected() ? 'はい' : 'いいえ') . "\n";
36
37    // 6. テキストノードをルート要素から削除
38    // この操作により、ノードはドキュメントツリーから「接続を失った」状態になります。
39    $root->removeChild($textNode);
40
41    // 7. ノードがドキュメントから削除された後の状態を確認
42    // ドキュメントツリーから切り離されたため、'いいえ' を返すはずです。
43    // これは、ネットワーク接続が「失われた」状況と概念的に似ています。
44    echo "ノード削除後: ドキュメントに接続されていますか？ " . ($textNode->isConnected() ? 'はい' : 'いいえ') . "\n";
45
46    echo "--- デモンストレーション終了 ---\n";
47}
48
49// 関数を実行して、DOMノードの接続状態の変化を確認します。
50demonstrateDomConnectionStatus();

このPHPコードは、DOM（Document Object Model）におけるノードの接続状態を確認するisConnected()メソッドの挙動を具体的に示しています。Dom\CharacterDataクラスはDom\Nodeを継承しており、このメソッドを利用できます。

isConnected()メソッドは引数を取らず、そのノードが現在DOMドキュメントツリーに接続されているかどうかを真偽値で返します。ノードがドキュメントツリーの一部である場合はtrueを、ツリーに属していない場合はfalseを返します。

サンプルコードではまず、新しいDOMドキュメントとルート要素を作成します。次に、Dom\CharacterDataを継承するテキストノードを生成し、ドキュメントにまだ追加されていない初期状態でisConnected()を呼び出し、falseが返されることを確認します。その後、テキストノードをドキュメントツリーに追加すると、isConnected()はtrueを返します。最後に、ノードをツリーから削除すると、再びisConnected()がfalseを返すことを確認できます。この一連の操作により、DOMノードの接続状態が動的に変化し、それをisConnected()メソッドで正確に把握できることがわかります。

Dom\CharacterDataクラスで利用されるisConnected()は、親クラスのDom\Nodeに定義されており、対象のDOMノードが現在のドキュメントツリーに接続されているかをブール値で判断します。リファレンス情報に「戻り値なし」とありますが、このメソッドはtrueまたはfalseを返しますのでご注意ください。これはネットワーク接続状態を示すものではなく、HTMLやXMLドキュメント構造におけるノードの所属状況を確認するものです。ノードがドキュメントツリーに追加されるとtrue、ツリーから削除されるとfalseになります。