PHP - xmlwriter_start_dtd_entity() Function

Previous
Quiz
Next

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_dtd_entity() function accepts an object of the XMLWriter class and a string value representing the name of the entity and a boolean value as parameters and creates a DTD entity start tag.

Syntax

xmlwriter_start_dtd_entity($writer, $name, $isParam);

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

name(Mandatory)

This is a string value representing the qualified name of the document type.
3

isParam (Mandatory)

This is a boolean value specifying whether the current entity is a parameter.

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

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

   //Starting the document
   xmlwriter_start_document($writer);

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

   //Creating a DTD entity start tag
   xmlwriter_start_dtd_entity($writer, 'test_entity', TRUE);

   //Ending the DTD entity end tag
   xmlwriter_end_dtd_entity($writer);
   xmlwriter_start_element($writer, 'address');

   //Starting a element tag
   xmlwriter_start_element($writer, 'name');
   
   //Adding text to the element
   xmlwriter_text($writer, 'Tanmay Patil');  
   xmlwriter_end_element($writer);
   xmlwriter_start_element($writer, 'company');
   
   //Adding text to the element
   xmlwriter_text($writer, 'TutorialsPoint');  
   xmlwriter_end_element($writer);
   xmlwriter_start_element($writer, 'phone');
   
   //Adding text to the element
   xmlwriter_text($writer, '(011) 123-4567');  
   xmlwriter_end_element($writer);

   //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"?>
<!ENTITY % test_entity>
<address>
   <name>Tanmay Patil</name>
   <company>TutorialsPoint</company>
   <phone>(011) 123-4567</phone>
</address>

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

   //Setting the indentation on
   $writer->setIndent(TRUE);
   
   //Setting the indentation
   $writer->setIndentString("    ");

   //Creating a DTD entity start tag
   $writer->startDtdEntity('test_entity', TRUE);

   //Ending the DTD entity end tag
   $writer->endDtdEntity();

   //Starting an element
   $writer->startElement('Tutorial');
   $writer->startElement('name');
   
   //Adding text to the element
   $writer->text('JavaFX');  
   $writer->endElement();
   $writer->startElement('Author');
   
   //Adding text to the element
   $writer->text('Krishna');  
   $writer->endElement();

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

This will generate the following XML document −

<?xml version="1.0"?>
<!ENTITY % test_entity>
<Tutorial>
   <name>JavaFX</name>
   <Author>Krishna</Author>
</Tutorial>
php_function_reference.htm
Print Page
Previous
Next
Advertisements