Added addChildCdata method to XmlElement. Added ability to turn off formatting for XmlFiles. Formatter is broken for CDATA sections that contain HTML.

Author: homer6

README.md

@@ -20,6 +20,8 @@ Dependencies
      - Extensions:
        - CURL
        - mongodb client
+       - libxml (--enable-libxml)
+       - simplexml
   - "Altumo Packages" require mongodb 1.2+
   - Classes under the Symfony_1_4 directory depend on Symfony 1.4
 

source/php/Xml/XmlElement.php

@@ -39,7 +39,7 @@ class XmlElement{
     * 
     * @param string|\SimpleXMLElement $xml_string
     * @throws \Exception if SimpleXML is not loaded 
-    * @return XmlElement
+    * @return \Altumo\Xml\XmlElement
     */    
     public function __construct( $xml_string = null ){
 
@@ -159,6 +159,7 @@ public function queryWithXpath( $xpath_query, $return_type = self::RETURN_TYPE_S
     * @param string $filename
     * @throws \Exception if file does not exist
     * @throws \Exception if contents are not valid XML
+    * @return \Altumo\Xml\XmlElement
     */
     public function loadFromFile( $filename ){
 
@@ -169,6 +170,8 @@ public function loadFromFile( $filename ){
         $contents = file_get_contents($filename);
         $this->setContentsByString($contents);
 
+        return $this;
+        
     }
 
 
@@ -177,6 +180,7 @@ public function loadFromFile( $filename ){
     * 
     * @param string $xml_string
     * @throws \Exception on parse error
+    * @return \Altumo\Xml\XmlElement
     */   
     public function setContentsByString( $xml_contents ){
 
@@ -203,6 +207,8 @@ public function setContentsByString( $xml_contents ){
         if( !$this->isValid() ){
             throw new \Exception('XML Failed to parse.');
         }
+        
+        return $this;
 
     }
 
@@ -211,6 +217,7 @@ public function setContentsByString( $xml_contents ){
     * Creates a XmlElement
     * 
     * @param string $xml_string
+    * @return \Altumo\Xml\XmlElement
     */   
     public function setContentsBySimpleXMLElement( $xml_contents ){
 
@@ -221,7 +228,8 @@ public function setContentsBySimpleXMLElement( $xml_contents ){
 
         $this->xml_element = $xml_contents;
         $this->setLoaded(true);
-        $this->setValid(true);        
+        $this->setValid(true);
+        return $this;    
 
     }
 
@@ -384,7 +392,7 @@ public function getXmlAsString( $pretty = false, $include_xml_declaration = true
     * @param string $name
     * @param string $value
     * @param string $namespace
-    * @return XmlElement
+    * @return \Altumo\Xml\XmlElement
     */
     public function addAttribute( $name, $value, $namespace = null ){
 
@@ -401,17 +409,62 @@ public function addAttribute( $name, $value, $namespace = null ){
     * @param string $name
     * @param string $value
     * @param string $namespace
-    * @return XmlElement
+    * @return \Altumo\Xml\XmlElement
     */
     public function addChild( $name, $value = null, $namespace = null ){
 
         $this->assertLoaded();
+        /*
+        if( is_string($value) ){
+            //$value = str_replace( ' ', ' ', $value ); 
+            //$value = htmlentities( $value , ENT_COMPAT | ENT_HTML401 );
+        }*/
         $child = $this->getXmlElement()->addChild( $name, $value, $namespace );
+        
         return new XmlElement($child);
 
     }
 
 
+    /** 
+    * Add CDATA text in a node 
+    * @param string $cdata_text The CDATA value  to add
+    * 
+    * @author Alexandre FERAUD
+    * @see http://www.php.net/manual/en/simplexmlelement.addchild.php
+    */ 
+    protected function addCdata( $cdata_text ){
+        
+        $node = dom_import_simplexml( $this->getXmlElement() );
+        $owner_document = $node->ownerDocument; 
+        $node->appendChild( $owner_document->createCDATASection($cdata_text) );
+        
+    } 
+
+    
+    /** 
+    * Create a child element with CDATA value.
+    * 
+    * @param string $name                   
+    *   //The name of the child element to add. 
+    * 
+    * @param string $cdata_text 
+    *   //The CDATA value of the child element.
+    * 
+    * @author Alexandre FERAUD
+    * @see http://www.php.net/manual/en/simplexmlelement.addchild.php
+    * 
+    * @return \Altumo\Xml\XmlElement
+    */ 
+    public function addChildCdata( $name, $cdata_text, $namespace = null ){
+        
+        $child = $this->addChild( $name, null, $namespace );
+        $child->addCdata( $cdata_text );
+        return $this;
+        
+    } 
+
+    
     /**
     * Formats the xml string provided as a pretty output.
     * 

source/php/Xml/XmlFile.php

@@ -317,13 +317,16 @@ protected function assertFileOpen(){
     * @param boolean $write                 //whether this method should write 
     *                                         the contents before closing.  
     *                                         Defaults to yes.
+    * 
+    * @param boolean $format_xml            //whether the xml will be "pretty"
+    * 
     */
-    public function closeFile( $write = true ){
+    public function closeFile( $write = true, $format_xml = true ){
 
         if( $this->isFileOpen() ){
 
             if( !$this->isReadOnly() ){
-                $this->writeToFile();
+                $this->writeToFile( $format_xml );
             }
 
             fclose( $this->getFilePointer() ); 
@@ -341,12 +344,13 @@ public function closeFile( $write = true ){
     /**
     * Saves the contents to the file.
     * 
+    * @param boolean $format_xml            //whether the xml will be "pretty"
     */
-    public function writeToFile(){
+    public function writeToFile( $format_xml = true ){
 
         $this->assertFileOpen();
         $this->assertFileWritable();
-        $file_contents = $this->getXmlRoot()->getXmlAsString(true);
+        $file_contents = $this->getXmlRoot()->getXmlAsString( $format_xml );
         $file_pointer = $this->getFilePointer();
         ftruncate( $file_pointer, 0 );
         rewind( $file_pointer );