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

    Description

    Object-oriented style

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

    Procedural style

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

    Flushes the current buffer.

    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().

    empty

    Whether to empty the buffer or not. Default is true.

    Return Values

    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.

    Changelog

    Version Description
    8.0.0 writer expects an XMLWriter instance now; previously, a resource was expected.
    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

    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>
    */
    ?>
    ＋add a note
    To Top