PHP - xmlwriter_start_attribute() 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_start_attribute() function accepts an object of the XMLWriter class and a string value representing the name of the attribute of an element and creates a start attribute tag.

Syntax

xmlwriter_start_attribute($writer, $name);

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

<?php
   //Creating an XMLWriter
   $writer = new XMLWriter();
   $uri = "result.xml";

   //Opening a writer
   $writer = xmlwriter_open_uri($uri);

   //Starting the document
   xmlwriter_start_document($writer);

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

   //Setting the attribute 
   xmlwriter_start_attribute($writer, 'attr'); 
   xmlwriter_text($writer, 'test_value'); 
   xmlwriter_end_attribute($writer);

   //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);
?>

This will generate the following XML document −

<?xml version="1.0"?>
<Msg attr="test_value">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->openUri($uri);

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

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

   //Setting the attribute 
   $writer->startAttribute('attr'); 
   $writer->text('test_value'); 
   $writer->endAttribute();

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

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

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

This will generate the following XML document −

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

Example

Following is another example of this function −

<?php
   //Creating an XMLWriter
   $writer = new XMLWriter();
   $uri = "result.xml";

   //Opening a writer
   $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');
   xmlwriter_start_element($writer, 'name');

   //Setting attribute to the element name
   xmlwriter_start_attribute($writer, 'id'); 
   xmlwriter_text($writer, '10001');
   xmlwriter_end_attribute($writer);

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

   //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 id="10001">JavaFX</name>
   <Author>Krishna</Author>
   <Pages>535</Pages>
</Tutorial>