XMLWriter::endDocument

xmlwriter_end_document

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

XMLWriter::endDocument -- xmlwriter_end_documentEnd current document

Description

Object-oriented style

public XMLWriter::endDocument(): bool

Procedural style

xmlwriter_end_document(XMLWriter $writer): bool

Ends the current 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().

Return Values

Returns true on success or false on failure.

Changelog

Version Description
8.0.0 writer expects an XMLWriter instance now; previously, a resource was expected.

See Also

add a note

User Contributed Notes 1 note

up
1
Sbastien
3 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