XMLWriter::startDocument

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

XMLWriter::startDocument — Dokument beginnen

Beschreibung

Objektorientierter Stil

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

Prozeduraler Stil

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

Beginnt ein neues Dokument.

Parameter-Liste

writer: Nur für prozedurale Aufrufe. Die XMLWriter-Instanz, die bearbeitet werden soll. Dieses Objekt wird von Aufrufen von xmlwriter_open_uri() oder xmlwriter_open_memory() geliefert.
version: Versionsnummer des Dokuments als Teil der XML-Deklaration.
encoding: Kodierung des Dokuments als Teil der XML-Deklaration.
standalone: yes oder no.

Rückgabewerte

Gibt bei Erfolg true zurück. Bei einem Fehler wird false zurückgegeben.

Fehler/Exceptions

Wenn für encoding ein Wert mit Null-Bytes übergeben wird, wird ein ValueError geworfen.

Changelog

Version	Beschreibung
8.4.0	Wenn für `encoding` ein Wert mit Null-Bytes übergeben wird, wird nun ein ValueError geworfen.
8.0.0	`writer` erwartet nun eine XMLWriter-Instanz; vorher wurde eine Ressource erwartet.

Siehe auch

XMLWriter::endDocument() - Beendet Dokument

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 ¶

2 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