PHP - xmlwriter_end_cdata() 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_end_cdata() function accepts an object of the XMLWriter class and creates a end CDATA tag.

Syntax

xmlwriter_end_cdata($writer);

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_end_cdata() 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');
    
   //Starting the Cdata 
   xmlwriter_start_cdata($writer); 
     
   //Setting value to the Cdata
   xmlwriter_text($writer, 'test_value'); 
     
   //Ending the Cdata 
   xmlwriter_end_cdata($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><![CDATA[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');

   //Starting the Cdata 
   $writer->startCdata(); 
    
   //Setting value to the Cdata
   $writer->text('test_value'); 
     
   //Ending the Cdata 
   $writer->endCdata(); 

   //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><![CDATA[test_value]]>Welcome to Tutorialspoint</Msg>