導入
システム間連携において、XMLは依然として重要なデータフォーマットです。特に、社内システムや古いWeb APIとの通信では、スキーマ定義（DTD）を伴うXMLの出力が求められることがあります。今回解説する XMLWriter::endDtdElement は、XMLのDTD（Document Type Definition）を手動構築する際に、要素定義の終了を明示するメソッドです。一見マイナーな機能ですが、複雑なXML構造を動的に生成する際、整合性の取れたファイルを書き出すために欠かせないTipsです。
基礎知識
DTDは、XMLドキュメントがどのような構造（どの要素がどの順番で現れるか等）を持つべきかを定義するルールブックです。PHPの XMLWriter は、メモリ効率が良く、ストリーミング形式でXMLを生成できるため、大規模なXMLを出力する際に重宝されます。DTDを出力する際は、startDtdElement で定義を開始し、endDtdElement で終了させる必要があります。この対になるメソッドを正確に呼び出さないと、生成されたXMLが不正な形式となり、読み込み側のパーサーでエラーが発生する原因となります。
実装/解決策
XMLWriterを使用してDTDを含む文書を作成する際は、以下のステップを踏みます。
1. XMLWriterの初期化（メモリへの書き出し）
2. DTDの出力開始
3. 各要素の定義（startDtdElement → 内容 → endDtdElement）
4. XML本体の書き出し
この順序を守ることで、標準に準拠したXMLファイルを作成できます。特に、DTDの定義はXMLの宣言直後に行う必要があるため、処理順序には注意してください。
サンプルプログラム
以下は、DTD定義を含むXMLを生成する具体的なコードです。
openMemory();
$writer->setIndent(true);
// XMLドキュメントの開始
$writer->startDocument(‘1.0’, ‘UTF-8’);
// DTDの開始（ルート要素を指定）
$writer->startDtd(‘root’);
$writer->endDtd();
// DTD要素定義の開始
$writer->startDtdElement(‘user’);
// ここにDTDの定義内容を記述（例: (#PCDATA)）
$writer->text(‘(#PCDATA)’);
// 定義を終了する（ここが重要）
$writer->endDtdElement();
// XML本体の記述
$writer->startElement(‘root’);
$writer->writeElement(‘user’, ‘Taro Yamada’);
$writer->endElement();
// ドキュメント終了
$writer->endDocument();
// 結果を出力
echo $writer->outputMemory();
?>
応用・注意点
実務で陥りやすい罠として、endDtdElement の呼び出し忘れが挙げられます。特に条件分岐でXML構造を構築している場合、例外発生時に終了処理がスキップされると、不完全なXMLが生成されてしまいます。これを防ぐために、try-finally構文を用いて、処理の最後には必ず終了メソッドが呼ばれるように設計することをお勧めします。また、PHP 8.0以降では XMLWriter がリソース型からオブジェクト型に完全に移行しているため、古いコードを保守する際は、引数の型チェックを厳密に行うようにしましょう。