PHP | XMLWriter startDocument() Function

0 0 1 minute read

The XMLWriter::startDocument() function is an inbuilt function in PHP which is used to start the document. This document then needs to be ended with XMLWriter::endDocument function.

Syntax:

bool XMLWriter::startDocument( string $version, 
string $encoding, string $standalone )

Parameters: This function accepts three parameters as mentioned above and described below:

$version (Optional): It specifies the version number of the document as part of the XML declaration.
$encoding (Optional): It specifies the encoding of the document as part of the XML declaration.
$standalone (Optional): It specifies whether document is standalone or not.

Return Value: This function returns TRUE on success or FALSE on failure.

Below examples illustrate the XMLWriter::startDocument() function in PHP:

Example 1:

<?php 
  
// Create a new XMLWriter instance 
$writer = new XMLWriter(); 
  
// Create the output stream as PHP 
$writer->openURI('php://output'); 
  
// Start the document 
$writer->startDocument('1.0', 'UTF-8'); 
  
// Start a element 
$writer->startElement('div'); 
  
// Add value to the element 
$writer->text('zambiatek'); 
  
// End the element 
$writer->endElement(); 
  
// End the document 
$writer->endDocument(); 
?> 

Output:

<?xml version="1.0" encoding="UTF-8"?>
<div>zambiatek</div>

Example 2:

<?php 
  
// Create a new XMLWriter instance 
$writer = new XMLWriter(); 
    
// Create the output stream as PHP 
$writer->openURI('php://output'); 
    
// Start the document 
$writer->startDocument('1.0', 'UTF-8'); 
    
// Start a h1 element 
$writer->startElement('h1'); 
    
// Start the style attribute 
$writer->startAttribute('style'); 
    
// Add value to the attribute 
$writer->text('color:orange;font-size:80px;'); 
    
// End the attribute 
$writer->endAttribute(); 
    
// Add value to the element 
$writer->text('zambiatek'); 
    
// End the element 
$writer->endElement(); 
    
// End the document 
$writer->endDocument(); 
?> 