PHP - xmlwriter_set_indent_string() 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_set_indent_string() function accepts an object of the XMLWriter class and, a string representing that is to be used as indentation as parameters and sets the indentation of the output XML document accordingly.

xmlwriter_set_indent($writer, $indentStr);

Parameters

Return Values

This function returns a boolean value which is TRUE in case of success and 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_set_indent() function −

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

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

   //Starting the document
   xmlwriter_start_document($writer);

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

   //Setting indentation
   xmlwriter_set_indent($writer,TRUE);
   xmlwriter_set_indent_string($writer, "    ");

   //Creating XML elements
   xmlwriter_write_element($writer, 'name', 'JavaFX');  
   xmlwriter_write_element($writer, 'author', 'Krishna');  
   xmlwriter_write_element($writer, 'pages', '535');  

   //Ending the element
   xmlwriter_end_element($writer);

   //Ending the document
   xmlwriter_end_document($writer);
   print("XML Document Created");
?>

This will generate the following XML document −

<?xml version="1.0"?>
<Tutorial>
   <Name>JavaFX</Name>
   <Author>Krishna</Author>
   <Pages>535</Pages>
</Tutorial> 

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->openUri($uri);

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

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

   //Setting indentation
   $writer->setIndent(TRUE);
   $writer->setIndentString("    ");
   
   //Creating XML elements
   $writer->writeElement('Name', 'JavaFX');  
   $writer->writeElement('Author', 'Krishna'); 
   $writer->writeElement('Pages', '535');  

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

   //Ending the document
   $writer->endDocument();
?> 

This will generate the following XML document −

<?xml version="1.0"?>
<Tutorial>
   <Name>JavaFX</Name>
   <Author>Krishna</Author>
   <Pages>535</Pages>
</Tutorial>