XMLWriter::flush

xmlwriter_flush

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

XMLWriter::flush -- xmlwriter_flush — Flush current buffer

Опис

Об'єктно-орієнтований стиль

public XMLWriter::flush(bool $empty = true): string|int

Процедурний стиль

xmlwriter_flush(XMLWriter $writer, bool $empty = true): string|int

Flushes the current buffer.

Параметри

writer: Тільки для процедурних викликів. Примірник XMLWriter, що буде оброблятися. Цей об'єкт повертається функцією xmlwriter_open_uri() або xmlwriter_open_memory().
empty: Whether to empty the buffer or not. Default is true.

Значення, що повертаються

If you opened the writer in memory, this function returns the generated XML buffer, Else, if using URI, this function will write the buffer and return the number of written bytes.

Журнал змін

Версія	Опис
8.0.0	Тепер `writer` має бути примірником XMLWriter. Раніше очікувався resource.
8.0.0	This function can no longer return `false`.

Improve This Page

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::flush() basic usage with XMLWriter::openMemory() :

<?php
$xml = new XMLWriter();
$xml->openMemory();
$xml->startDocument();
$xml->writeElement('message', 'Hello World!');
$xml->endDocument();
echo $xml->flush();

/*
Produces :

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

＋add a note