PHP 8.1.28 Released!

XMLWriter::endDocument

xmlwriter_end_document

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

XMLWriter::endDocument -- xmlwriter_end_documentBeendet Dokument

Beschreibung

Objektorientierter Stil

public XMLWriter::endDocument(): bool

Prozeduraler Stil

xmlwriter_end_document(XMLWriter $writer): bool

Beendet das aktuelle 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.

Rückgabewerte

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

Changelog

Version Beschreibung
8.0.0 writer erwartet nun eine XMLWriter-Instanz; vorher wurde eine Ressource erwartet.

Siehe auch

add a note

User Contributed Notes 1 note

up
0
Sbastien
2 years ago
XMLWriter::endDocument() closes properly all remaining elements not yet closed.

Without XMLWriter::endDocument() :

<?php
$xml
= new XMLWriter();
$xml->openUri('php://stdout');
$xml->startDocument();
$xml->startElement('a');
$xml->startElement('b');
$xml->startElement('c');
$xml->startAttribute('foo');
exit;

/*
Outputs :
<?xml version="1.0"?>
<a><b><c foo="
*/
?>

With XMLWriter::endDocument() :

<?php
$xml
= new XMLWriter();
$xml->openUri('php://stdout');
$xml->startDocument();
$xml->startElement('a');
$xml->startElement('b');
$xml->startElement('c');
$xml->startAttribute('foo');
$xml->endDocument();
exit;

/*
Outputs :
<?xml version="1.0"?>
<a><b><c foo=""/></b></a>
*/
?>
To Top