XMLWriter::startDocument

xmlwriter_start_document

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

XMLWriter::startDocument -- xmlwriter_start_document — Crea un documento

Descripción

Estilo orientado a objetos

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

Estilo procedimental

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

Comienza un documento.

Parámetros

writer: Únicamente para llamadas procedimentales. La instancia XMLWriter que es modificada. Este objeto proviene de una llamada a xmlwriter_open_uri() o xmlwriter_open_memory().
version: El número de versión del documento en la declaración XML.
encoding: La codificación del documento en la declaración XML.
standalone: yes o no.

Valores devueltos

Esta función retorna true en caso de éxito o false si ocurre un error.

Errores/Excepciones

Pasar un encoding que contenga bytes nulos lanzará una excepción ValueError.

Historial de cambios

Versión	Descripción
8.4.0	Pasar un `encoding` que contenga bytes nulos lanza ahora una excepción ValueError.
8.0.0	`writer` ahora espera una instancia de XMLWriter anteriormente, se esperaba una resource.

Ver también

XMLWriter::endDocument() - Finaliza el actual documento

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 1 note

down

Sbastien ¶

3 years ago

XMLWriter::startDocument() writes the XML declaration.

Without XMLWriter::startDocument() :

<?php

$xml = new XMLWriter();
$xml->openUri('php://stdout');
$xml->writeElement('message', 'Hello World!');
exit;

/*
Outputs :
<message>Hello World!</message>
*/
?>

With XMLWriter::startDocument() :

<?php

$xml = new XMLWriter();
$xml->openUri('php://stdout');
$xml->startDocument();
$xml->writeElement('message', 'Hello World!');
exit;

/*
Outputs :
<?xml version="1.0"?>
<message>Hello World!</message>
*/
?>

＋add a note