• PHP Video Tutorials

PHP - xmlwriter_output_memory() 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_output_memory() function returns the current buffer.

Syntax

xmlwriter_output_memory($writer, $bool);

Parameters

Sr.No Parameter & Description
1

writer(Mandatory)

This is an object of the XMLWriter class representing the XML document that you want to modify/create.

2

bool(Optional)

This is a boolean value specifying whether to flush the buffer or not.

Return Values

This function returns a XMLWriter object in case of success and a boolean value which is FALSE in case of failure.

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_output_memory() function −

<?php
   //Opening a writer
   $writer = xmlwriter_open_memory();

   //Starting the document
   xmlwriter_start_document($writer);

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

   //Adding text to the element
   xmlwriter_text($writer, 'Welcome to Tutorialspoint');  

   //Ending the element
   xmlwriter_end_element($writer);

   //Ending the document
   xmlwriter_end_document($writer);

   $res = xmlwriter_output_memory($writer);
   print($res);
?>

This will generate the following XML document −

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

Example

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

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

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

   //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->endElement();

   //Ending the document
   $writer->endDocument();
   $res = $writer->outputMemory();
   print($res);
?>

This will generate the following XML document −

<?xml version="1.0"?>
<Msg>Welcome to Tutorialspoint</Msg>
php_function_reference.htm
Advertisements