【PHP8.x】DOMEntity::isSupported()メソッドの使い方

Copy
1<?php
2
3/**
4 * DOMEntity::isSupported メソッドの使用例。
5 *
6 * このメソッドは、特定のDOM機能（$feature）とバージョン（$version）が、
7 * ターゲットのDOMEntityノードでサポートされているかを確認するために使用されます。
8 *
9 * DOMEntityは通常、DTD (Document Type Definition) を持つXMLドキュメントから取得されます。
10 * 以下の例では、インメモリのXML文字列を使用してDOMEntityを取得し、isSupportedを呼び出します。
11 */
12
13// DTD（Document Type Definition）を含むXML文字列を定義します。
14// ここで 'my_entity' という名前のエンティティを定義しています。
15$xmlString = <<<XML
16<!DOCTYPE root [
17  <!ENTITY my_entity "この値はエンティティです。">
18]>
19<root>
20  <item>&my_entity;</item>
21</root>
22XML;
23
24// DOMDocumentオブジェクトを作成し、XML文字列を読み込みます。
25$dom = new DOMDocument();
26$dom->loadXML($xmlString);
27
28// ドキュメントのDOCTYPE（DTD情報）を取得します。
29$doctype = $dom->doctype;
30
31if ($doctype instanceof DOMDocumentType) {
32    // DTDから名前 'my_entity' のDOMEntityオブジェクトを取得します。
33    // DOMEntityMapは、DTDで定義されたエンティティの集合です。
34    $entity = $doctype->entities->getNamedItem('my_entity');
35
36    if ($entity instanceof DOMEntity) {
37        echo "DOMEntity 'my_entity' が見つかりました。\n\n";
38
39        // DOMEntity::isSupported メソッドを呼び出して、
40        // 特定の機能（'XML'）とバージョン（'1.0'）がサポートされているかを確認します。
41        $featureToCheck = 'XML';
42        $versionToCheck = '1.0';
43        $isSupportedXml10 = $entity->isSupported($featureToCheck, $versionToCheck);
44
45        echo "DOMEntityは機能 '{$featureToCheck}' バージョン '{$versionToCheck}' をサポートしていますか？\n";
46        echo "結果: " . ($isSupportedXml10 ? 'はい' : 'いいえ') . "\n";
47
48        // 注意: DOM Level 2 Core の仕様では、isSupported メソッドは常に false を返すように定義されています。
49        // これは、DOMの異なる実装間での互換性のために存在しますが、
50        // 実際にはサポート状況を動的に判断する用途では利用されません。
51        echo "\n(注: DOM Level 2 Core の仕様では、isSupported メソッドは常に 'いいえ' を返します。)\n";
52
53        // 別の機能とバージョンで試す場合も、同様に「いいえ」が返されます。
54        $featureToCheck = 'HTML';
55        $versionToCheck = '2.0';
56        $isSupportedHtml20 = $entity->isSupported($featureToCheck, $versionToCheck);
57
58        echo "\nDOMEntityは機能 '{$featureToCheck}' バージョン '{$versionToCheck}' をサポートしていますか？\n";
59        echo "結果: " . ($isSupportedHtml20 ? 'はい' : 'いいえ') . "\n";
60
61    } else {
62        echo "指定されたDOMEntity 'my_entity' が見つかりませんでした。\n";
63    }
64} else {
65    echo "XMLドキュメントにDTD（DOCTYPE）情報が見つかりませんでした。\n";
66}
67

DOMEntity::isSupportedメソッドは、XMLドキュメントのDTD（Document Type Definition）で定義されるエンティティが、特定のDOM機能とバージョンをサポートしているかを確認するために使用されます。このメソッドは、第一引数$featureで確認したい機能の名前（例: 'XML'）を、第二引数$versionでその機能のバージョン（例: '1.0'）を文字列として受け取ります。そして、指定された機能とバージョンがサポートされていればtrue、そうでなければfalseをブール値として返します。

サンプルコードでは、まずDTDを含むXML文字列からDOMDocumentを介してDOMDocumentTypeを取得し、その中からmy_entityという名前のDOMEntityオブジェクトを取得しています。その後、取得した$entityに対してisSupportedメソッドを呼び出し、XML機能の1.0バージョンがサポートされているかを確認しています。

しかし、DOM Level 2 Coreの仕様上、DOMEntity::isSupportedメソッドは、DOMの実装に関わらず常にfalse（サポートしていない）を返すように定義されています。これは、DOMの異なる実装間での互換性を保つための設計であり、実際にはエンティティが特定の機能を動的にサポートするかを判断する用途では使われません。そのため、サンプルコードの実行結果は、指定された機能やバージョンに関わらず、常に「いいえ」と表示されます。このメソッドは、歴史的な経緯から存在しますが、現代のPHPアプリケーション開発で特定の機能を動的にチェックするために利用されることはほとんどありません。

Copy
1<?php
2
3// DOMEntity::isSupported メソッドのサンプル
4// このメソッドは、DOM実装が特定の「機能（feature）」と「バージョン」を、
5// このDOMEntityノードのコンテキストでサポートしているかをチェックします。
6// PHP自体のバージョンサポートや、PHPの特定の機能が利用可能かとは直接関係ありません。
7// 主にDOM仕様のモジュールが指定されたバージョンでサポートされているかを確認するために使用されます。
8
9function checkDomEntitySupport(string $feature, string $version): void
10{
11    // ダミーのXMLを作成し、DTDでエンティティを定義します。
12    // DOMEntityインスタンスを取得するためには、DTDにエンティティ定義が必要です。
13    $xmlString = <<<XML
14<!DOCTYPE example_root [
15  <!ENTITY myentity "My custom entity content.">
16]>
17<example_root>&myentity;</example_root>
18XML;
19
20    $dom = new DOMDocument();
21    // 外部エンティティの読み込みを許可しない設定（セキュリティのため推奨）
22    $dom->substituteEntities = false;
23    $dom->loadXML($xmlString);
24
25    // DTDが存在し、かつエンティティが定義されていることを確認します。
26    if ($dom->doctype && $dom->doctype->entities && $dom->doctype->entities->length > 0) {
27        // 最初のエンティティノードを取得します。
28        /** @var DOMEntity $domEntity */
29        $domEntity = $dom->doctype->entities->item(0);
30
31        echo "DOM Entity Found: " . $domEntity->nodeName . "\n";
32        echo "Checking if DOM feature '{$feature}' version '{$version}' is supported by this entity...\n";
33
34        // DOMEntity::isSupported メソッドを呼び出します。
35        $isSupported = $domEntity->isSupported($feature, $version);
36
37        if ($isSupported) {
38            echo "Result: '{$feature}' version '{$version}' is Supported! 🎉\n";
39        } else {
40            echo "Result: '{$feature}' version '{$version}' is Not Supported. 😞\n";
41        }
42    } else {
43        echo "No DTD or entities found in the XML document to test DOMEntity::isSupported.\n";
44    }
45}
46
47// サンプル実行: さまざまなDOM機能とバージョンでサポート状況をチェックします。
48// これらのテストは、PHPのDOM拡張が特定のDOM仕様モジュールをサポートしているかを示します。
49// 'XML'と'Core'は基本的なDOM機能であり、通常は指定されたバージョンでサポートされています。
50
51// XML Coreモジュール バージョン1.0 のサポートをチェック
52checkDomEntitySupport('XML', '1.0');
53echo "\n";
54
55// XML Coreモジュール バージョン2.0 のサポートをチェック
56checkDomEntitySupport('XML', '2.0');
57echo "\n";
58
59// DOM Coreモジュール バージョン2.0 のサポートをチェック
60checkDomEntitySupport('Core', '2.0');
61echo "\n";
62
63// HTMLモジュール バージョン1.0 のサポートをチェック (DOMEntityではあまり直接的な意味はないが、例として)
64checkDomEntitySupport('HTML', '1.0');
65echo "\n";
66
67// 存在しない、またはサポートされないであろう機能とバージョン
68checkDomEntitySupport('NonExistentFeature', '99.9');
69

PHPのDOMEntity::isSupportedメソッドは、DOM実装（PHPのDOM拡張機能）が、特定の「機能（feature）」と「バージョン」を、このDOMEntityノードの文脈でサポートしているかを確認するメソッドです。

引数$featureには、確認したいDOMの機能名を文字列で指定します。例えば、DOMのコア機能を示す「Core」や、XML関連機能を示す「XML」などです。引数$versionには、その機能のバージョンを「1.0」や「2.0」といった文字列で指定します。 このメソッドは、指定された機能とバージョンがサポートされていればtrueを、サポートされていなければfalseをブール値で返します。

このメソッドは、PHP自体のバージョンサポートや、PHPの特定の機能が利用可能かとは直接関係ありません。主にDOMの国際標準仕様に基づいた機能が、現在のDOM実装で利用できるかを確認するために使用されます。

サンプルコードでは、XML内にDTD（Document Type Definition）でエンティティを定義し、そこからDOMEntityインスタンスを取得しています。そして、isSupportedメソッドを用いて「XML 1.0」や「Core 2.0」といった一般的なDOM機能のサポート状況をチェックしています。これにより、特定のDOM仕様に準拠した処理を安全に実行できるか判断できます。