CakeFest 2024: The Official CakePHP Conference

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 создаётся в памяти, то функция вернёт сгенерированный буфер XML, иначе, при использовании URI, эта функция запишет буфер и вернёт количество записанных байт.

Список изменений

Версия Описание
8.0.0 В параметре writer теперь ожидается экземпляр класса XMLWriter; раньше параметр ждал ресурс (resource).
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