XMLWriter::flush

xmlwriter_flush

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

XMLWriter::flush -- xmlwriter_flush現在のバッファをフラッシュする

説明

オブジェクト指向型

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

手続き型

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

現在のバッファをフラッシュします。

パラメータ

writer

手続き型のコールでのみ使用します。 変更される XMLWriter のインスタンスです。 このインスタンスは、xmlwriter_open_uri() あるいは xmlwriter_open_memory() を呼び出すことで取得したものです。

empty

バッファを空にするかどうか。デフォルトは true です。

戻り値

ライターをメモリにオープンした場合は、この関数は出来上がった XML バッファを返します。 そうではなく URI を使用している場合は、この関数はバッファを書き込み、 書き込んだバイト数を返します。

変更履歴

バージョン 説明
8.0.0 引数 writer は、XMLWriter のインスタンスを期待するようになりました。 これより前のバージョンでは、リソースが期待されていました。
8.0.0 この関数は、false を返さなくなりました。
add a note

User Contributed Notes 1 note

up
1
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>
*/
?>
To Top