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

Copy
1<?php
2
3/**
4 * Dom\Document::isConnected プロパティの利用例。
5 *
6 * このプロパティは、DOMノードがドキュメントツリーに接続されているかを示します。
7 * Dom\Document オブジェクト自体は常にドキュメントツリーのルートとして存在するため、
8 * その isConnected プロパティは常に true を返します。
9 * これは、システムが常に自身の基盤と接続されていると見なされるのと同様です。
10 */
11function demonstrateDocumentConnection(): void
12{
13    // 新しい Dom\Document オブジェクトを作成します。
14    // これは、XML/HTMLドキュメント全体のルートを表すオブジェクトです。
15    $document = new Dom\Document();
16
17    echo "Dom\\Document オブジェクトの接続状態の確認:" . PHP_EOL;
18
19    // Dom\Document::isConnected プロパティにアクセスし、ドキュメントが接続されているか確認します。
20    // Dom\Document オブジェクトは常に自身をドキュメントツリーの一部と見なすため、
21    // このプロパティは常に true を返します。
22    if ($document->isConnected) {
23        echo "  - ドキュメントはドキュメントツリーに接続されています (bool: true)。" . PHP_EOL;
24    } else {
25        echo "  - ドキュメントはドキュメントツリーに接続されていません (bool: false)。" . PHP_EOL;
26    }
27
28    // isConnected プロパティの戻り値が確実に boolean 型であることを示します。
29    echo "  - isConnected プロパティの戻り値の型: " . gettype($document->isConnected) . PHP_EOL;
30}
31
32// 関数を実行し、Dom\Document オブジェクトの接続状態を確認します。
33demonstrateDocumentConnection();

このサンプルコードは、PHPのDom\DocumentクラスにおけるisConnectedプロパティの使用例を紹介しています。isConnectedプロパティは、DOM（Document Object Model）ノードがドキュメントツリーに接続されているかを示すブール値（trueまたはfalse）を返します。このプロパティは引数を受け取りません。

Dom\Documentオブジェクトは、XMLやHTMLドキュメント全体のルート、つまり最も上位の要素を表します。そのため、Dom\Documentオブジェクト自体は常にドキュメントツリーの基盤として存在します。したがって、Dom\DocumentオブジェクトのisConnectedプロパティは常にtrueを返します。

コードではまず、新しいDom\Documentオブジェクトを作成しています。次に、作成した$documentオブジェクトのisConnectedプロパティにアクセスし、その接続状態を確認しています。実行すると「ドキュメントはドキュメントツリーに接続されています」と表示され、プロパティの戻り値が期待通りbool型であることが確認できます。このisConnectedプロパティは、ドキュメントの接続状態を真偽値で簡潔に伝える役割を担っています。

Copy
1<?php
2
3/**
4 * Paho MQTTクライアントの設定ドキュメントの「接続状態」をチェックします。
5 *
6 * この関数は、`Dom\Document`オブジェクトを使用して、Pahoクライアントが使用する
7 * XML設定の整合性や読み込み状態を模擬的に検証します。
8 * `Dom\Document::isConnected`プロパティは、ノードがDOMツリーに接続されているかを
9 * 示します。`Dom\Document`オブジェクト自体は、生成されれば自身のツリーのルートとして
10 * 常に「接続済み」（true）と見なされます。
11 * ここでは、設定XMLの読み込みに成功し、かつドキュメントが有効な状態である場合に
12 * 「接続済み」と判断することで、「Paho接続ロスト」というキーワードに対する
13 * 概念的な状態チェックを表現しています。
14 *
15 * @param string $configXml Pahoクライアント設定を含むXML文字列
16 * @return bool 設定ドキュメントが概念的に「接続済み」（有効にロードされた）であればtrue、そうでなければfalse
17 */
18function checkPahoConfigStatus(string $configXml): bool
19{
20    $document = new Dom\Document();
21    $isLoadedAndValid = false;
22
23    // XMLのパースエラーを内部で処理し、loadXMLの戻り値で判定するために設定
24    $prevErrors = libxml_use_internal_errors(true);
25    libxml_clear_errors();
26
27    try {
28        // XMLとして設定を読み込もうと試みます。
29        // 読み込みが成功すればtrue、失敗すればfalseを返します。
30        if ($document->loadXML($configXml)) {
31            $isLoadedAndValid = true;
32        } else {
33            // XML読み込みに失敗した場合、エラーを記録します。
34            // これをPaho設定への「接続が失われた」状態と見なします。
35            foreach (libxml_get_errors() as $error) {
36                error_log("XML parsing error: " . $error->message);
37            }
38            $isLoadedAndValid = false;
39        }
40    } catch (\Throwable $e) {
41        // 予期せぬ例外が発生した場合
42        error_log("An unexpected error occurred during XML loading: " . $e->getMessage());
43        $isLoadedAndValid = false;
44    } finally {
45        libxml_clear_errors();
46        libxml_use_internal_errors($prevErrors);
47    }
48
49    // Dom\Document::isConnected は、Dom\Documentオブジェクト自体に対しては常にtrueを返します。
50    // そのため、ここではXMLの読み込みが成功したかどうかのフラグと組み合わせて、
51    // 全体としての概念的な「接続状態」を判断します。
52    return $isLoadedAndValid && $document->isConnected;
53}
54
55// --- 単体動作可能なコードの例 ---
56
57// 正常なPahoクライアント設定を表すXML
58$validPahoConfig = <<<XML
59<paho-config>
60    <client id="myClient" host="mqtt.example.com" port="1883"/>
61    <topic subscribe="sensors/temp"/>
62</paho-config>
63XML;
64
65// 不正なPahoクライアント設定を表すXML (閉じタグがないため構文エラー)
66$invalidPahoConfig = <<<XML
67<paho-config>
68    <client id="myClient" host="mqtt.example.com" port="1883"/>
69    <topic subscribe="sensors/temp"/>
70XML;
71
72// 正常な設定のチェック
73if (checkPahoConfigStatus($validPahoConfig)) {
74    echo "Paho configuration is conceptually 'connected' (valid and loaded).\n";
75    // ここでPahoクライアントの初期化や接続処理に進む
76} else {
77    echo "Paho configuration is conceptually 'connection lost' (invalid or failed to load).\n";
78    // 接続ロスト状態としてエラー処理や再試行を行う
79}
80
81echo "\n";
82
83// 不正な設定のチェック
84if (checkPahoConfigStatus($invalidPahoConfig)) {
85    echo "Paho configuration is conceptually 'connected' (valid and loaded).\n";
86} else {
87    echo "Paho configuration is conceptually 'connection lost' (invalid or failed to load).\n";
88}

このPHPコードは、Paho MQTTクライアントの設定ドキュメントが有効に読み込めているかをチェックするものです。具体的には、Dom\Documentオブジェクトを使用してXML文字列を解析し、その健全性を確認します。

Dom\Document::isConnectedプロパティは、通常、XMLツリー内の要素がツリーに接続されているかを示しますが、Dom\Documentオブジェクト自体に対しては、生成された時点で常にtrueを返します。このサンプルコードでは、このプロパティとXMLの読み込み成否を組み合わせて、設定ドキュメントの「概念的な接続状態」を判断しています。

checkPahoConfigStatus関数は、引数としてPahoクライアント設定を含むXML文字列を受け取ります。内部では、$document->loadXML()メソッドを用いてXMLの構文チェックと読み込みを試みます。XMLがエラーなく正常に読み込めた場合に、設定ドキュメントが「概念的に接続済み」（有効な状態）であると判断し、trueを返します。もしXMLの構文エラーなどで読み込みに失敗した場合は、「概念的に接続が失われた」（無効な状態）と判断し、falseを返します。

このように、この関数は「Paho接続ロスト」というキーワードに対して、クライアント自体の接続状態ではなく、その設定ドキュメントがシステム上で適切に扱える状態にあるかという「概念的な接続状態チェック」を提供しています。