XMLWriter
PHP Manual

XMLWriter::startDocument

xmlwriter_start_document

Create document tag

Description

Object-oriented style

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

Procedural style

bool xmlwriter_start_document(
    XMLWriter $writer,
    stringnull $version = "1.0",
    stringnull $encoding = null,
    stringnull $standalone = null
)

Starts a document.

Parameters

writer

Only for procedural calls. The XMLWriter instance that is being modified. This object is returned from a call to xmlwriter_open_uri or xmlwriter_open_memory.

version

The version number of the document as part of the XML declaration.

encoding

The encoding of the document as part of the XML declaration.

standalone

yes or no.

Return Values

Returns true on success or false on failure.

Errors/Exceptions

Passing an encoding containing null bytes will throw a ValueError.

Changelog

Version Description
8.4.0 Passing an encoding containing null bytes will now throw a ValueError.
8.0.0 writer expects an XMLWriter instance now; previously, a resource was expected.

See Also

  • XMLWriter::endDocument