【PHP8.x】isSupportedメソッドの使い方

isSupportedメソッドは、特定の機能が現在のDOMEntityノードでサポートされているかを確認するメソッドです。

このメソッドは、PHPのDOM拡張機能の一部として提供されており、XMLドキュメント内の特定のエンティティノードが、DOM（Document Object Model）標準によって定義された特定の「機能」（例えば、XMLパーシングの特定のモジュール）や「バージョン」（例えば、'1.0'や'2.0'など）を扱える能力があるかどうかを判定するために使用されます。これにより、プログラムが実行される環境や、利用しているDOMライブラリの実装に依存する可能性のある操作を行う前に、その操作が現在のエンティティノードで実行可能であるかを事前に確認できます。

isSupportedメソッドは通常、第一引数にチェックしたい機能の名前を示す文字列（例: "XML"）、第二引数にその機能のバージョンを示す文字列（例: "1.0"）を取ります。指定された機能とバージョンが現在のDOMEntityノードでサポートされていればブール値のtrueを返し、サポートされていなければfalseを返します。この結果を利用することで、アプリケーションは異なる環境やDOM実装間での互換性を考慮した堅牢な処理フローを構築し、予期せぬエラーを防ぐことが可能になります。特に、さまざまなDOM標準に準拠する必要があるXML処理アプリケーションにおいて、このメソッドは有効な機能テストの手段となります。

Copy
1<?php
2$xmlString = <<<XML
3<?xml version="1.0" encoding="utf-8"?>
4<!DOCTYPE root [
5    <!ENTITY myEntity "entity content">
6]>
7<root/>
8XML;
9
10$doc = new DOMDocument();
11$doc->loadXML($xmlString);
12
13// 'myEntity' という名前の DOMEntity オブジェクトを取得します
14$entity = $doc->doctype->entities->getNamedItem('myEntity');
15
16// DOMEntity::isSupported の構文
17// isSupported(string $feature, string $version): bool
18$isSupported = $entity->isSupported('XML', '1.0');
19
20// このメソッドは常に false を返すため、結果は bool(false) となります
21var_dump($isSupported);
22?>

string $feature, string $version

• string $feature: サポートされている機能の名前を表す文字列
• string $version: 指定された機能のバージョンを表す文字列

bool

このメソッドは、指定されたエンティティがDOMによってサポートされているかどうかを示す真偽値（boolean）を返します。サポートされている場合は true、そうでない場合は false が返されます。