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

Copy
1<?php
2
3/**
4 * DOMEntity::isConnected プロパティのサンプルコード
5 *
6 * このコードは、XMLドキュメントのDTD（Document Type Definition）で宣言されたエンティティが、
7 * そのドキュメントに「接続されているか」（つまり、ドキュメントツリーの一部であるか）を
8 * 確認する方法を示します。
9 * ここでの「接続」は、ネットワーク接続の状態ではなく、DOMツリー内の位置を指します。
10 */
11function checkDomEntityConnectionStatus(): void
12{
13    // 1. 新しいDOMDocumentオブジェクトを作成
14    $dom = new DOMDocument('1.0', 'UTF-8');
15    // DTDを使用するため、standalone属性をfalseに設定
16    $dom->standalone = false;
17
18    // 2. エンティティ宣言を含むXML文字列をロード
19    // <!ENTITY example_entity "Example Value"> というエンティティをDTDで宣言しています。
20    $xmlString = <<<XML
21<?xml version="1.0" encoding="UTF-8"?>
22<!DOCTYPE root [
23  <!ENTITY example_entity "Example Value">
24  <!ELEMENT root ANY>
25]>
26<root>
27</root>
28XML;
29    $dom->loadXML($xmlString);
30
31    $myEntity = null;
32
33    // 3. ドキュメントのDTD（Document Type Definition）からエンティティリストを取得
34    // DTDが存在し、その中にエンティティが定義されていることを確認します。
35    if ($dom->doctype && $dom->doctype->entities) {
36        // 名前が 'example_entity' であるDOMEntityオブジェクトを取得します。
37        $myEntity = $dom->doctype->entities->getNamedItem('example_entity');
38    }
39
40    // 4. DOMEntityオブジェクトが存在するか確認し、isConnectedプロパティをチェック
41    if ($myEntity instanceof DOMEntity) {
42        // DOMEntity::isConnected プロパティは、このノードがそのオーナー・ドキュメントのツリーに
43        // 含まれている場合に true を返します。
44        // DTDで宣言され、正常にロードされたエンティティは、通常このプロパティが true となります。
45        if ($myEntity->isConnected) {
46            echo "DOMEntity '{$myEntity->nodeName}' はドキュメントに接続されています。\n";
47        } else {
48            echo "DOMEntity '{$myEntity->nodeName}' はドキュメントに接続されていません。\n";
49        }
50    } else {
51        echo "DOMEntity 'example_entity' が見つかりませんでした。\n";
52        echo "DTDにこのエンティティが正しく宣言されているか確認してください。\n";
53    }
54}
55
56// 関数を実行して結果を表示
57checkDomEntityConnectionStatus();
58

PHPのDOMEntity::isConnectedプロパティは、XMLドキュメントのDTD（Document Type Definition）で宣言されたエンティティが、そのドキュメントツリーに「接続されているか」どうかを判定する真偽値（bool）です。この「接続」とは、ネットワークの接続状態ではなく、DOM（Document Object Model）ツリーの一部として、そのドキュメント内に実際に存在し、認識されているかを意味します。このプロパティは引数を取らず、エンティティがドキュメントツリーに含まれている場合にtrueを、そうでなければfalseを返します。

サンプルコードでは、XMLのDTDにexample_entityというエンティティを宣言し、それをDOMDocumentにロードする例を示しています。ロードされたDOMEntityオブジェクトに対し、isConnectedプロパティを参照することで、そのエンティティがオーナーとなるドキュメントのツリーに組み込まれているかを確認しています。DTDで適切に定義され、ドキュメントに読み込まれたエンティティは、通常このプロパティがtrueを返します。これにより、XML構造内でエンティティが有効に機能しているか判断することができます。

Copy
1<?php
2
3/**
4 * DOMEntity::isConnected プロパティの使用例を示します。
5 * このプロパティは、DOMノードがドキュメントツリーに接続されているかを示します。
6 * DOMEntity::isConnected はネットワーク接続ではなく、DOMツリー内でのノードの接続状態を示します。
7 *
8 * @return void
9 */
10function demonstrateDomEntityConnection(): void
11{
12    $dom = new DOMDocument('1.0', 'UTF-8');
13    $dom->recover = false; // XMLパースエラーを抑制しない
14    $dom->preserveWhiteSpace = false; // ホワイトスペースを保持しない
15    $dom->formatOutput = true; // 出力時に整形する
16
17    // DTDにエンティティを定義したXML文字列をロードします。
18    // DOMEntityオブジェクトは、DTD内で宣言されたエンティティを表します。
19    // これらのエンティティノード自体は、多くの場合、メインのドキュメントツリーには直接接続されません。
20    $xmlString = <<<XML
21<!DOCTYPE root [
22  <!ENTITY exampleEntity "This is an example entity.">
23]>
24<root>
25  <text>Using &exampleEntity; in the document.</text>
26</root>
27XML;
28
29    // XMLをロードし、パースを試みます。
30    if (!$dom->loadXML($xmlString)) {
31        echo "Error loading XML.\n";
32        return;
33    }
34
35    // DOMDocumentType（文書型定義）を取得します。
36    $doctype = $dom->doctype;
37
38    if ($doctype && $doctype->entities) {
39        echo "--- DOM Entity Connection Status Check ---\n";
40
41        // 名前で「exampleEntity」というDOMEntityノードを取得します。
42        $entityNode = $doctype->entities->getNamedItem('exampleEntity');
43
44        if ($entityNode) {
45            // DOMEntityのisConnectedプロパティにアクセスします。
46            // このプロパティは、ノードがそのドキュメントのツリー内に存在するかを返します。
47            // DOMEntityノードはDTDの一部であり、通常、メインのドキュメントツリーに直接接続されていないため、
48            // falseを返すことが一般的です。
49            $isConnected = $entityNode->isConnected;
50            echo "Entity 'exampleEntity' is connected to the document tree: " . ($isConnected ? 'true' : 'false') . "\n";
51        } else {
52            echo "Entity 'exampleEntity' not found in DTD.\n";
53        }
54        echo "------------------------------------------\n";
55    } else {
56        echo "No Document Type or Entities found in the XML, or parsing failed.\n";
57    }
58}
59
60// 関数を実行してDOMEntityの接続状態を確認します。
61demonstrateDomEntityConnection();

このサンプルコードは、PHPのDOM操作においてDOMEntity::isConnectedプロパティの挙動を示すものです。DOMEntity::isConnectedは、特定のDOMノードが、そのノードが属するドキュメントのメインツリーに実際に接続されているかどうかを真偽値（bool）で返します。このプロパティに引数を渡す必要はありません。

このプロパティは、ネットワーク接続の状態を示すものではなく、XMLやHTMLの文書構造内でのノードの位置に関する情報を提供します。サンプルコードでは、DTD（文書型定義）内で定義された「exampleEntity」というエンティティを取得し、そのisConnectedプロパティを確認しています。

DOMEntityノードは通常、DTDの一部として存在し、直接メインのドキュメントツリー内には配置されません。そのため、DOMEntity::isConnectedは一般的にfalseを返します。サンプルコードを実行すると、エンティティがドキュメントツリーに接続されていないことを示す「false」が出力され、このプロパティの挙動を具体的に理解できます。これは、XML文書の内部構造を理解する上で役立つ情報です。