XMLWriter::startDocument

xmlwriter_start_document

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

XMLWriter::startDocument -- xmlwriter_start_documentCria tag de documento

Descrição

Estilo orientado a objetos

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

Estilo procedural

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

Inicia um documento.

Parâmetros

writer

Apenas para chamadas procedurais. A instância de XMLWriter que está sendo modificada. Este objeto é retornado de uma chamada a xmlwriter_open_uri() ou xmlwriter_open_memory().

version

O número da versão do documento como parte da declaração XML.

encoding

A codificação do documento como parte da declaração XML.

standalone

yes ou no.

Valor Retornado

Retorna true em caso de sucesso ou false em caso de falha.

Erros/Exceções

Passar um encoding contendo bytes nulos irá gerar um ValueError.

Registro de Alterações

Versão Descrição
8.4.0 Passar um encoding contendo bytes nulos agora lançará um ValueError.
8.0.0 O parâmetro writer agora espera uma instância de XMLWriter; anteriormente, um resource era esperado.

Veja Também