【PHP8.x】XMLReader::SUBST_ENTITIES定数の使い方

XMLReader::SUBST_ENTITIES定数は、XML文書を読み込む際に、宣言されているエンティティ参照を自動的にその実体内容に置き換えるかどうかを制御するための定数です。PHPのXMLReaderクラスは、XML文書を効率的にストリーム形式で解析するための機能を提供します。XML文書には、&のような予約文字を表す文字実体参照や、DTD（Document Type Definition）で定義された一般実体参照など、様々なエンティティ参照が含まれることがあります。

このXMLReader::SUBST_ENTITIES定数は、XMLReader::setParserProperty()メソッドを通じてパーサーのオプションとして設定されます。この定数を有効にすると（内部的には2という値に対応します）、XMLReaderはXML文書を読み込む際に、検出したエンティティ参照をその実体内容に自動的に展開し、置き換えてから返します。例えば、DTDで<!ENTITY company "Example Inc.">と定義されており、XML内で&company;と記述されている場合、この定数を有効にすることで「Example Inc.」として読み込まれるようになります。

一方で、この定数を無効にした場合（デフォルトの挙動）、エンティティ参照はそのままの形で（例: &company;として）読み込まれ、アプリケーション側で別途解析や置換処理を行う必要が生じます。XMLReader::SUBST_ENTITIESを適切に設定することで、XML文書の解析処理をより簡潔にし、必要な情報を効率的に取得することが可能になります。特に、DTDで定義された外部エンティティを含むXML文書を扱う際に、そのエンティティ参照を自動的に解決したい場合に役立つ定数です。

Copy
1<?php
2$reader = new XMLReader();
3$reader->setParserProperty(XMLReader::SUBST_ENTITIES, true);

引数なし

引数はありません

戻り値なし

戻り値はありません