Added support for encoding and decoding namespaced xml (xmlns)

Author: mattvick

Encoder/XmlEncoder.php

@@ -99,7 +99,22 @@ public function decode($data, $format, array $context = array())
         // todo: throw an exception if the root node name is not correctly configured (bc)
 
         if ($rootNode->hasChildNodes()) {
-            return $this->parseXml($rootNode);
+
+            $xpath = new \DOMXPath($dom);
+            $data = array();
+            foreach ($xpath->query('namespace::*', $dom->documentElement) as $nsNode) {
+                $data['@'.$nsNode->nodeName] = $nsNode->nodeValue;
+            }
+
+            if (isset($data['@xmlns:xml'])) {
+                unset($data['@xmlns:xml']);
+            }
+
+            if (empty($data)) {
+                return $this->parseXml($rootNode);
+            }
+
+            return array_merge($data, (array) $this->parseXml($rootNode));
         }
 
         if (!$rootNode->hasAttributes()) {
@@ -227,7 +242,7 @@ final protected function isElementNameValid($name)
     {
         return $name &&
             false === strpos($name, ' ') &&
-            preg_match('#^[\pL_][\pL0-9._-]*$#ui', $name);
+            preg_match('#^[\pL_][\pL0-9._:-]*$#ui', $name);
     }
 
     /**
@@ -281,11 +296,11 @@ private function parseXmlAttributes(\DOMNode $node)
 
         $data = array();
 
-        foreach ($node->attributes as $attrkey => $attr) {
+        foreach ($node->attributes as $attr) {
             if (ctype_digit($attr->nodeValue)) {
-                $data['@'.$attrkey] = (int) $attr->nodeValue;
+                $data['@'.$attr->nodeName] = (int) $attr->nodeValue;
             } else {
-                $data['@'.$attrkey] = $attr->nodeValue;
+                $data['@'.$attr->nodeName] = $attr->nodeValue;
             }
         }
 

Tests/Encoder/XmlEncoderTest.php

@@ -203,6 +203,14 @@ public function testEncode()
         $this->assertEquals($source, $this->encoder->encode($obj, 'xml'));
     }
 
+    public function testEncodeWithNamespace()
+    {
+        $source = $this->getNamespacedXmlSource();
+        $array = $this->getNamespacedArray();
+
+        $this->assertEquals($source, $this->encoder->encode($array, 'xml'));
+    }
+
     public function testEncodeSerializerXmlRootNodeNameOption()
     {
         $options = array('xml_root_node_name' => 'test');
@@ -253,6 +261,14 @@ public function testDecodeCdataWrappingAndWhitespace()
         $this->assertEquals($expected, $this->encoder->decode($xml, 'xml'));
     }
 
+    public function testDecodeWithNamespace()
+    {
+        $source = $this->getNamespacedXmlSource();
+        $array = $this->getNamespacedArray();
+
+        $this->assertEquals($array, $this->encoder->decode($source, 'xml'));
+    }
+
     public function testDecodeScalarWithAttribute()
     {
         $source = '<?xml version="1.0"?>'."\n".
@@ -414,6 +430,53 @@ protected function getXmlSource()
             '</response>'."\n";
     }
 
+    protected function getNamespacedXmlSource()
+    {
+        return '<?xml version="1.0"?>'."\n".
+            '<response xmlns="http://www.w3.org/2005/Atom" xmlns:app="http://www.w3.org/2007/app" xmlns:media="http://search.yahoo.com/mrss/" xmlns:gd="http://schemas.google.com/g/2005" xmlns:yt="http://gdata.youtube.com/schemas/2007">'.
+            '<qux>1</qux>'.
+            '<app:foo>foo</app:foo>'.
+            '<yt:bar>a</yt:bar><yt:bar>b</yt:bar>'.
+            '<media:baz><media:key>val</media:key><media:key2>val</media:key2><item key="A B">bar</item>'.
+            '<item><title>title1</title></item><item><title>title2</title></item>'.
+            '<Barry size="large"><FooBar gd:id="1"><Baz>Ed</Baz></FooBar></Barry></media:baz>'.
+            '</response>'."\n";
+    }
+
+    protected function getNamespacedArray()
+    {
+        return array(
+            '@xmlns'       => 'http://www.w3.org/2005/Atom', 
+            '@xmlns:app'   => 'http://www.w3.org/2007/app', 
+            '@xmlns:media' => 'http://search.yahoo.com/mrss/',
+            '@xmlns:gd'    => 'http://schemas.google.com/g/2005',
+            '@xmlns:yt'    => 'http://gdata.youtube.com/schemas/2007',
+            'qux' => "1",
+            'app:foo' => "foo",
+            'yt:bar' => array("a", "b"),
+            'media:baz' => array(
+                'media:key' => "val",
+                'media:key2' => "val",
+                'A B' => "bar",
+                'item' => array(
+                    array(
+                        'title' => 'title1',
+                    ), 
+                    array(
+                        'title' => 'title2',
+                    )
+                ),
+                'Barry' => array(
+                    '@size' => 'large',
+                    'FooBar' => array(
+                        'Baz'    => 'Ed',
+                        '@gd:id' => 1,
+                    ),
+                ),
+            ),
+        );
+    }
+
     protected function getObject()
     {
         $obj = new Dummy();