DOMDocument Function createComment

PHP Version: (No version information might be only in CVS. I have used this function in PHP5)

DOM: W3C DOM Level 1

Description

This function creates a new comment node.

Usage:

object DOMDocument->createComment ( string data)

This function returns a new instance of class DOMComment. The content of the comment is the value of the passed parameter. This node will not show up in the document unless it is inserted with e.g. DOMNode->appendChild().

The return value is FALSE if an error occurred.

Example:

The XML file, which I have used contains following data. I have stored this file in “c:/topxml_demo/php/xml_files/employee.xml” directory.

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

<employee>

            <employeename>test</employeename>

            <employeeaddress>test123</employeeaddress>

            <SSN>12343456</SSN>

                        <company>TOPXML</company>

</employee>

PHP Code:

<?php

    $doc = new DomDocument;

// Load the xml file into DOMDocument

$doc->Load('C:/topxml_demo/php/xml_files/employee.xml');

// We retrieve the attribute named id of the employee element

$employee = $doc->getElementsByTagName('employeename')->item(0);

//Create a CDATA node

$newCommentNode = $doc ->createComment('This is a Comment created for employeename element');

//append the new Comment node into the employeename element

$employee -> appendChild($newCommentNode);

//save the DOMDocument into a file

$test = $doc->save("C:/topxml_demo/php/xml_files/save1.xml");

 echo "<B>DOMDocument->createComment example<B>"

 ?>

Output:

The Content of save1.xml is

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

<employee>

     <employeename>test<!--This is a Comment created for employeename element-->

     </employeename>

     <employeeaddress>test123</employeeaddress>

     <SSN>12343456</SSN>

     <company>TOPXML</company>

</employee>