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

Copy
1<?php
2
3/**
4 * DOMCharacterData::isSupported メソッドの使用例を示します。
5 * このメソッドは、DOMNode クラスから継承されており、
6 * DOM の特定の機能が指定されたバージョンでサポートされているかを確認します。
7 *
8 * @param string $feature 確認したいDOM機能の名称 (例: 'XML', 'HTML', 'Core')
9 * @param string $version 確認したいDOM機能のバージョン (例: '1.0', '2.0', '3.0')
10 * @return void
11 */
12function checkDomFeatureSupport(string $feature, string $version): void
13{
14    // DOMCharacterData を継承する DOMText クラスのインスタンスを作成します。
15    // isSupported メソッドは DOMNode クラスに定義されており、
16    // DOMCharacterData のサブクラスからも呼び出し可能です。
17    $domText = new DOMText('Sample text content');
18
19    // 指定されたDOM機能とバージョンがPHPのDOM実装でサポートされているかを確認します。
20    if ($domText->isSupported($feature, $version)) {
21        echo "DOM機能 '{$feature}' (バージョン: {$version}) はサポートされています。\n";
22    } else {
23        echo "DOM機能 '{$feature}' (バージョン: {$version}) はサポートされていません。\n";
24    }
25}
26
27// サンプル使用例: XML 1.0 機能のサポートを確認
28// ほとんどのPHP環境でサポートされているはずです。
29checkDomFeatureSupport('XML', '1.0');
30
31// サンプル使用例: HTML 2.0 機能のサポートを確認
32// この機能のサポートは環境に依存しますが、多くの場合はサポートされないでしょう。
33checkDomFeatureSupport('HTML', '2.0');
34
35// サンプル使用例: Core 3.0 機能のサポートを確認
36// 一般的にこのバージョンはサポートされていないため、「サポートされていません」と表示されるはずです。
37checkDomFeatureSupport('Core', '3.0');
38
39?>

PHPのDOMCharacterData::isSupportedメソッドは、現在のPHP環境のDOM実装が、指定された特定のDOM機能とバージョンをサポートしているかを確認するために使用されます。このメソッドはDOMNodeクラスで定義されており、DOMCharacterDataを含むその子クラスから利用できます。

引数には二つあります。一つ目の$featureには確認したいDOM機能の名称を文字列で指定します。例えば、'XML'、'HTML'、または'Core'といった主要なDOM機能です。二つ目の$versionには、その機能の具体的なバージョンを文字列で指定します。例えば、'1.0'や'2.0'などです。

このメソッドの戻り値は真偽値（bool）です。指定された機能とバージョンがサポートされていればtrue、サポートされていなければfalseを返します。

サンプルコードでは、DOMTextクラスのインスタンス（DOMCharacterDataを継承）を用いて、isSupportedメソッドの動作を示しています。例えば、checkDomFeatureSupport('XML', '1.0')のように呼び出すことで、XML 1.0機能がサポートされているかを確認し、その結果に応じて「サポートされています」または「サポートされていません」というメッセージが表示されます。これにより、開発者は実行環境が特定のDOM仕様に準拠しているかをプログラムで判断できます。

Copy
1<?php
2
3/**
4 * DOMCharacterData::isSupported メソッドの使用例。
5 * このメソッドは、特定のDOM機能が指定されたバージョンで、現在のPHP環境（DOM拡張）で
6 * サポートされているかを確認します。
7 *
8 * DOMCharacterData は DOMText や DOMComment などの抽象親クラスであるため、
9 * これらの継承クラスのインスタンスを通じてメソッドを呼び出す必要があります。
10 *
11 * 注: このメソッドはDOM Level 2で導入されましたが、DOM Level 3以降では非推奨となっています。
12 *     現代のDOMプログラミングでは、DOMImplementation::hasFeature() の使用が推奨されます。
13 *     現在のPHP環境では、以下の基本的な機能に対しては通常 true を返します。
14 */
15function checkDomCharacterDataSupport(): void
16{
17    // DOMCharacterDataのインスタンスを直接作成することはできません。
18    // DOMDocumentを作成し、テキストノードを生成してDOMTextオブジェクトを取得します。
19    // DOMText は DOMCharacterData を継承しているため、isSupported メソッドを使用できます。
20    $dom = new DOMDocument();
21    $textNode = $dom->createTextNode('Example text data');
22
23    // DOMの 'Core' 機能が '2.0' バージョンでサポートされているかを確認します。
24    // 'Core' は、DOMの中心的な機能セットを指します。
25    $isCore2_0Supported = $textNode->isSupported('Core', '2.0');
26    echo "DOM 'Core' feature (version '2.0') supported: " . ($isCore2_0Supported ? 'Yes' : 'No') . PHP_EOL;
27
28    // DOMの 'XML' 機能が '1.0' バージョンでサポートされているかを確認します。
29    $isXml1_0Supported = $textNode->isSupported('XML', '1.0');
30    echo "DOM 'XML' feature (version '1.0') supported: " . ($isXml1_0Supported ? 'Yes' : 'No') . PHP_EOL;
31}
32
33// 関数を実行します。
34checkDomCharacterDataSupport();

PHPのDOMCharacterData::isSupportedメソッドは、指定されたDOM機能が現在のPHP環境（DOM拡張）で特定のバージョンをサポートしているかを確認するために使用されます。このメソッドは、確認したい機能の名称をstring型の引数$feature（例: DOMの根幹となる機能セットである「Core」や、XML文書に関する「XML」機能など）として受け取ります。次に、その機能のバージョンをstring型の引数$version（例: 「2.0」、「1.0」）として指定します。メソッドの戻り値はbool型で、機能がサポートされていればtrueを、サポートされていなければfalseを返します。

DOMCharacterDataは抽象クラスのため、直接インスタンスを作成することはできません。そのため、サンプルコードのようにDOMTextなどDOMCharacterDataを継承する具象クラスのインスタンスを通じてこのメソッドを利用します。ここでは「Core」機能のバージョン「2.0」や「XML」機能のバージョン「1.0」のサポート状況を確認し、その結果を出力しています。

注意点として、このメソッドはDOM Level 3以降では非推奨となっており、現代のDOMプログラミングではDOMImplementation::hasFeature()メソッドの使用が推奨されています。この点にご留意ください。