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

startDocumentメソッドは、XMLドキュメントの開始部分を書き込むメソッドです。このメソッドは、XML宣言と呼ばれる、XMLファイルの冒頭に記述される特別な情報を生成するために使用されます。XML宣言には、使用するXMLのバージョン、文字エンコーディング、そしてドキュメントが単独で完結しているかどうかを示すスタンドアロン属性が含まれます。

このメソッドは、以下の3つのオプション引数を受け取ります。 一つ目の$version引数では、XMLのバージョンを指定します。通常は"1.0"が用いられ、省略された場合もデフォルトで"1.0"が適用されます。 二つ目の$encoding引数では、ドキュメントの文字エンコーディングを指定します。例えば、日本語を含むXMLを生成する際には"UTF-8"や"Shift_JIS"などを指定します。これも省略可能であり、省略された場合は通常"UTF-8"が使用されます。 三つ目の$standalone引数では、XMLドキュメントが外部のDTD（文書型定義）などを参照せずに単独で処理可能であるかをブール値（trueまたはfalse）で示します。

XMLWriterを使用してXMLドキュメントの生成を開始する際、通常、このstartDocumentメソッドを最初に呼び出してXML宣言を記述します。これにより、生成されるXMLドキュメントが正しい形式で開始されることが保証されます。メソッドが成功するとtrueを返し、失敗した場合はfalseを返します。このメソッドを呼び出す前に、XMLWriter::openMemory()やXMLWriter::openURI()などのメソッドで出力先を設定しておく必要があります。

Copy
1public XMLWriter::startDocument(string $version = '1.0', string $encoding = null, string $standalone = null): bool

?string $version = '1.0', ?string $encoding = null, ?string $standalone = null

• string $version = '1.0': XML宣言のバージョンを指定する文字列。デフォルトは '1.0' です。
• string $encoding = null: XML文書のエンコーディングを指定する文字列。省略するとUTF-8が使用されます。
• string $standalone = null: XML宣言のstandalone属性を指定する文字列 ('' or 'yes' or 'no')。省略すると属性は出力されません。

bool

XMLWriter::startDocument メソッドは、XML文書の開始を宣言し、成功した場合は true を返します。処理中にエラーが発生した場合は false を返します。