XMLWriter::startDocument

xmlwriter_start_document

(PHP 5 >= 5.1.2, PHP 7, PHP 8, PECL xmlwriter >= 0.1.0)

XMLWriter::startDocument -- xmlwriter_start_document — ドキュメントタグを作成する

説明

オブジェクト指向型

public function XMLWriter::startDocument(?string $version = "1.0", ?string $encoding = null, ?string $standalone = null): bool

手続き型

function xmlwriter_start_document(
    XMLWriter $writer,
    ?string $version = "1.0",
    ?string $encoding = null,
    ?string $standalone = null
): bool

ドキュメントを開始します。

パラメータ

writer: 手続き型のコールでのみ使用します。変更される XMLWriter のインスタンスです。このインスタンスは、xmlwriter_open_uri() あるいは xmlwriter_open_memory() を呼び出すことで取得したものです。
version: XML 宣言で使用するドキュメントのバージョン番号。
encoding: XML 宣言で使用するドキュメントのエンコーディング。
standalone: yes あるいは no。

戻り値

成功した場合に true を、失敗した場合に false を返します。

エラー / 例外

encoding に null バイトを含む値を指定すると、 ValueError がスローされます。

変更履歴

バージョン	説明
8.4.0	`encoding` に null バイトを含む値を指定すると、 ValueError がスローされるようになりました。
8.0.0	引数 `writer` は、XMLWriter のインスタンスを期待するようになりました。これより前のバージョンでは、リソースが期待されていました。

参考

XMLWriter::endDocument() - 現在のドキュメントを終了する

関連キーワード:

XMLWriter xmlwriter encoding ドキュメントドキュメントタグ startDocument start document standalone writer インスタンス手続き宣言バイト ValueError 期待 startComment startDtd オブジェクト指向開始 memory 番号エンコーディング成功履歴