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

Copy
1<?php
2
3/**
4 * DOMCdataSection の isConnected メソッドの使用例
5 *
6 * この関数は、DOMCdataSection オブジェクトが DOM ツリーに接続されているか
7 * どうかを示す isConnected メソッドの動作を実演します。
8 * isConnected は、ノードがドキュメントの一部である場合に true を返します。
9 *
10 * @return void
11 */
12function demonstrateDomCdataSectionConnection(): void
13{
14    echo "DOMCdataSection::isConnected の使用例:\n\n";
15
16    // 1. 新しい DOM ドキュメントを作成します。
17    $document = new DOMDocument('1.0', 'UTF-8');
18    $document->formatOutput = true; // 出力整形を有効にします。
19
20    // 2. DOMCdataSection オブジェクトを作成します。
21    // この時点では、まだどのドキュメントにも追加されていません。
22    $cdata = $document->createCDATASection('このデータはCDATAセクションとして扱われます。');
23
24    // 3. CDATAセクションがドキュメントに接続されているかを確認します。
25    // まだドキュメントツリーに追加されていないため、false が期待されます。
26    echo "CDATAセクションをドキュメントに追加する前:\n";
27    echo "  isConnected: " . ($cdata->isConnected() ? 'true' : 'false') . "\n\n";
28
29    // 4. CDATAセクションをドキュメントツリーに追加します。
30    // まずルート要素を作成し、CDATAセクションをその子として追加します。
31    $rootElement = $document->createElement('dataContainer');
32    $document->appendChild($rootElement); // ルート要素をドキュメントに追加
33    $rootElement->appendChild($cdata);   // CDATAセクションをルート要素の子として追加
34
35    // 5. ドキュメントに追加された後の CDATAセクションの接続状態を確認します。
36    // ドキュメントに追加されたため、true が期待されます。
37    echo "CDATAセクションをドキュメントに追加した後:\n";
38    echo "  isConnected: " . ($cdata->isConnected() ? 'true' : 'false') . "\n\n";
39
40    // 6. 生成されたXMLドキュメントの内容を出力して確認します (オプション)。
41    echo "生成されたXMLドキュメント:\n";
42    echo $document->saveXML();
43    echo "\n";
44}
45
46// 上記の関数を実行して、DOMCdataSection::isConnected の動作を確認します。
47demonstrateDomCdataSectionConnection();

PHPのDOMCdataSectionクラスに属するisConnectedメソッドは、XMLやHTMLなどのドキュメント構造を扱う際に、特定のCDATAセクションがそのドキュメントツリーに「接続されているか」どうかを判定するために使用されます。このメソッドは引数を取りません。戻り値は真偽値（bool）であり、CDATAセクションがドキュメントツリーの一部である場合はtrueを、そうでない場合はfalseを返します。

例えば、DOMDocument内で新しいCDATAセクションをcreateCDATASectionメソッドで作成した直後、そのCDATAセクションはまだドキュメントツリーのどこにも追加されていないため、isConnectedメソッドを呼び出すとfalseが返されます。その後、appendChildなどのメソッドを使ってCDATAセクションをドキュメントの要素に追加すると、そのCDATAセクションはドキュメントツリーの一部として「接続された」状態になります。この状態でisConnectedを再度呼び出すと、trueが返されるようになります。

このようにisConnectedメソッドは、CDATAセクションが現在、有効なドキュメント構造の一部として存在しているかを簡単に確認できるため、DOM操作を行う際のノードの状態管理に役立ちます。

Copy
1<?php
2
3/**
4 * DOMCdataSection::isConnected プロパティの動作を示すサンプルコード。
5 *
6 * このコードは、DOMCdataSectionノードがXMLドキュメントツリーに
7 * 接続されているかどうかをチェックする方法を実演します。
8 * ノードがツリーに追加されたり削除されたりする際の接続状態の変化を確認します。
9 */
10
11// 新しいDOMDocumentを作成し、出力を整形する設定を行います。
12$dom = new DOMDocument('1.0', 'UTF-8');
13$dom->formatOutput = true;
14
15// ルート要素を作成し、DOMDocumentに追加します。
16$root = $dom->createElement('data');
17$dom->appendChild($root);
18
19echo "--- DOMCdataSection::isConnected プロパティの確認 ---\n";
20
21// 1. DOMCdataSectionノードを作成します。
22// この時点では、まだDOMツリーには追加されていません。
23$cdata = $dom->createCDATASection("これはCDATAセクションのデータです。特殊文字 < & > もそのまま扱われます。");
24
25echo "\n--- CDATAセクション作成直後 ---\n";
26// 作成直後のCDATAセクションの接続状態を確認します。
27// まだドキュメントツリーに追加されていないため、isConnectedはfalseを返します。
28echo "CDATAセクションはドキュメントに接続されていますか？: " . ($cdata->isConnected ? 'はい' : 'いいえ') . "\n";
29
30// 2. CDATAセクションノードをルート要素に「接続」（追加）します。
31$root->appendChild($cdata);
32
33echo "\n--- CDATAセクションをDOMツリーに追加後 ---\n";
34// DOMツリーに追加された後のCDATAセクションの接続状態を確認します。
35// ドキュメントツリーに接続されたため、isConnectedはtrueを返します。
36echo "CDATAセクションはドキュメントに接続されていますか？: " . ($cdata->isConnected ? 'はい' : 'いいえ') . "\n";
37
38// 3. DOMCdataSectionノードをDOMツリーから「切り離し」（削除）ます。
39// これは、DOMノードがドキュメントツリーから「接続が失われる」状況を再現します。
40$root->removeChild($cdata);
41
42echo "\n--- CDATAセクションをDOMツリーから削除後 (接続喪失) ---\n";
43// ドキュメントツリーから削除された後のCDATAセクションの接続状態を確認します。
44// DOMツリーから切り離されたため、isConnectedはfalseを返します。
45echo "CDATAセクションはドキュメントに接続されていますか？: " . ($cdata->isConnected ? 'はい' : 'いいえ') . "\n";
46
47echo "\n--- 最終的なXMLドキュメント (CDATAセクションは削除済み) ---\n";
48echo $dom->saveXML();
49

PHP 8のDOMCdataSection::isConnectedプロパティは、特定のCDATAセクションノードがXMLドキュメントのDOMツリーに現在接続されているかどうかを真偽値で示すものです。このプロパティには引数はなく、戻り値としてbool型（真偽値）を返します。

このプロパティは、CDATAセクションがXMLドキュメントの構造の一部として存在している場合にtrueを返し、まだDOMツリーに追加されていないか、すでにツリーから削除されている場合にはfalseを返します。

提供されたサンプルコードでは、DOMCdataSectionノードが作成された直後には、まだDOMツリーに接続されていないため、isConnectedはfalseとなります。次に、このノードをDOMDocumentのルート要素に追加すると、ノードはツリーの一部となるため、isConnectedはtrueに変化します。そして、このノードをDOMツリーから削除すると、ツリーとの接続が失われるため、isConnectedは再びfalseに戻ります。このように、isConnectedプロパティはXMLノードの状態を明確に示し、例えば「paho connection lost」のような、何らかの接続が失われた状況を確認する際に概念的に共通する状態管理に役立ちます。