PHP - xmlwriter_flush() Function

Definition and Usage

XML is a mark-up language to share the data across the web, XML is for both human read-able and machine read-able. XMLWriter extension internally has libxml xmlWriter API and is used to write/create the contents of an XML document. The XML documents generated by this are non-cached and forward-only.

The xmlwriter_flush() function accepts an object of the XMLWriter class as a parameter and flushes the current buffer.

Syntax

xmlwriter_flush($xmlwriter, $bool);

Parameters

Return Values

This function returns an XML buffer if the writer is opened in memory and it returns the number of bytes if we use URI.

PHP Version

This function was first introduced in PHP Version 5 and works in all the later versions.

Example

Following example demonstrates the usage of the xmlwriter_flush() function −

<?php
   //Opening a writer
   $uri = "result.xml";
   $writer = xmlwriter_open_uri($uri);

   //Starting the document
   xmlwriter_start_document($writer);

   //Creating XML elements
   xmlwriter_set_indent($writer, TRUE);
   xmlwriter_set_indent_string($writer, "    ");

   //Starting an element
   xmlwriter_start_element($writer, 'Tutorial');

   //Starting a element tag
   xmlwriter_start_element($writer, 'name');

   //Adding text to the element
   xmlwriter_text($writer, 'JavaFX');  
   xmlwriter_full_end_element($writer);
   xmlwriter_start_element($writer, 'Author');
   
   //Adding text to the element
   xmlwriter_text($writer, 'Krishna');  
   xmlwriter_full_end_element($writer);

   //Ending the element
   xmlwriter_full_end_element($writer);

   //Ending the document
   xmlwriter_full_end_element($writer);

   //Flushing the contents of the document
   xmlwriter_flush($writer, TRUE);
?> 

This will generate the following XML document −

<?xml version="1.0"?>
<Tutorial>
   <name>JavaFX</name>
   <Author>Krishna</Author>
</Tutorial>

Example

Following is the example of this function in object oriented style −

<?php
   //Creating an XMLWriter
   $writer = new XMLWriter();

   //Opening a writer
   $uri = "result.xml";
   $writer->openUri($uri);

   //Starting the document
   $writer->startDocument();

   //Starting an element
   $writer->startElement('Msg');

   //Adding text to the element
   $writer->text('Welcome to Tutorialspoint');  

   //Ending the element
   $writer->fullEndElement();

   //Ending the document
   $writer->fullEndElement();

   //Flushing the contents of the XMLWriter
   $writer->flush(TRUE);
?>

This will generate the following XML document −

<?xml version="1.0"?>
<Msg>Welcome to Tutorialspoint</Msg>