Added $elementMap override to parseInnerTree.

Author: evert

ChangeLog.md

@@ -1,6 +1,13 @@
 ChangeLog
 =========
 
+0.3.0 (2015-02-06)
+------------------
+
+* Added `$elementMap` argument to parseInnerTree, for quickly overriding
+  parsing rules within an element.
+
+
 0.2.2 (2015-02-05)
 ------------------
 

lib/Reader.php

@@ -87,9 +87,13 @@ function parse() {
      *
      * If there's both text and sub-elements, the text will be discarded.
      *
+     * If the $elementMap argument is specified, the existing elementMap will
+     * be overridden while parsing the tree, and restored after this process.
+     *
+     * @param array $elementMap
      * @return array|string
      */
-    function parseInnerTree() {
+    function parseInnerTree(array $elementMap = null) {
 
         $previousDepth = $this->depth;
 
@@ -103,6 +107,12 @@ function parseInnerTree() {
             return null;
         }
 
+        if (!is_null($elementMap)) {
+            $this->pushContext();
+            $this->elementMap = $elementMap;
+        }
+
+
         // Really sorry about the silence operator, seems like I have no
         // choice. See:
         //
@@ -125,7 +135,7 @@ function parseInnerTree() {
                     $this->read();
                     break 2;
                 case self::NONE :
-                    throw new ParseException('We hit the end of the document prematurely. This likely means that some parser "eats" too many elements.');
+                    throw new ParseException('We hit the end of the document prematurely. This likely means that some parser "eats" too many elements. Do not attempt to continue parsing.');
                 default :
                     // Advance to the next element
                     $this->read();
@@ -134,6 +144,9 @@ function parseInnerTree() {
 
         }
 
+        if (!is_null($elementMap)) {
+            $this->popContext();
+        }
         return ($elements?$elements:$text);
 
     }

lib/Version.php

@@ -14,6 +14,6 @@ class Version {
     /**
      * Full version number
      */
-    const VERSION = '0.2.2';
+    const VERSION = '0.3.0';
 
 }

tests/Sabre/XML/ReaderTest.php

@@ -340,5 +340,58 @@ function testBrokenXML() {
 
     }
 
+    /**
+     * @depends testMappedElement
+     */
+    function testParseInnerTree() {
+
+        $input = <<<BLA
+<?xml version="1.0"?>
+<root xmlns="http://sabredav.org/ns">
+  <elem1>
+     <elem1 />
+  </elem1>
+</root>
+BLA;
+
+        $reader = new Reader();
+        $reader->elementMap = [
+            '{http://sabredav.org/ns}elem1' => function(Reader $reader) {
+
+                $innerTree = $reader->parseInnerTree(['{http://sabredav.org/ns}elem1' => function(Reader $reader) {
+                    $reader->next();
+                    return "foobar";
+                }]);
+
+                return $innerTree;
+            }
+        ];
+        $reader->xml($input);
+
+        $output = $reader->parse();
+
+        $expected = [
+            'name' => '{http://sabredav.org/ns}root',
+            'value' => [
+                [
+                    'name' => '{http://sabredav.org/ns}elem1',
+                    'value' => [
+                        [
+                            'name' => '{http://sabredav.org/ns}elem1',
+                            'value' => 'foobar',
+                            'attributes' => [],
+                        ]
+                    ],
+                    'attributes' => [],
+                ],
+            ],
+            'attributes' => [],
+
+        ];
+
+        $this->assertEquals($expected, $output);
+
+    }
+
 }