【PHP8.x】XMLWriter::startDtd()メソッドの使い方
startDtdメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
startDtdメソッドは、PHPのXMLWriterクラスに属し、XMLドキュメントのDTD(Document Type Definition)宣言の開始を書き込むメソッドです。DTDとは、XMLドキュメントの構造や内容を定義する規約であり、XMLパーサーがドキュメントの整合性を検証するために利用されます。
このメソッドを呼び出すことで、XMLドキュメントの冒頭に<!DOCTYPE ... >の形式でDTD宣言の開始部分が記述されます。引数として、$qualifiedNameにはDTDが適用されるXMLドキュメントのルート要素名を指定します。例えば、HTMLドキュメントであれば「html」となります。
オプションの引数として$publicIdと$systemIdを指定できます。$publicIdは、DTDの公開識別子を指定し、例えばW3Cの標準DTDなどを参照する際に使用します。$systemIdは、DTDファイルの場所を示すURI(Uniform Resource Identifier)を指定します。これらのIDを設定することで、外部に定義されたDTDを参照し、XMLドキュメントの構造を検証できます。
startDtdメソッドは、XMLWriterで整形式なXMLドキュメントを生成する上で、ドキュメントの型定義を明確にし、その構造を保証するために非常に重要な役割を果たします。
構文(syntax)
1$xmlWriterInstance->startDtd('root', '', 'root.dtd');
引数(parameters)
string $qualifiedName, ?string $publicId = NULL, ?string $systemId = NULL
- string $qualifiedName: DTDの完全修飾名を指定する文字列
- ?string $publicId = NULL: DTDの公開識別子を指定する文字列。省略可能です。
- ?string $systemId = NULL: DTDのシステム識別子を指定する文字列。省略可能です。
戻り値(return)
bool
XMLWriter::startDtd メソッドは、DTD(Document Type Definition)の開始を宣言します。このメソッドは、DTDの宣言が成功した場合は TRUE を、失敗した場合は FALSE を返します。