XMLReaderIterator v0.1.9.

- fix XML declaration detection (thanks David Paz)
- added XMLReaderNode::expand() (thanks Thomas Weinert)
- added XMLReaderTestCase
- phpunit default configuration
- build: added build.sh script

Author: hakre

README.md

@@ -2,6 +2,8 @@
 
 ### Changelog:
 
+ - `0.1.9` maintenance release with fixes. added XMLReaderNode::expand().
+
  - `0.1.8` maintenance release with fixes.
 
  - `0.1.7` maintenance release with fixes.

build.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+#
+# build script on clean checkout
+#
+
+if [ ! -d vendor ]; then
+    echo "installing build dependencies..."
+    composer install
+fi
+
+if [ ! -d vendor ]; then
+    echo "build dependencies not installed!"
+    exit 1
+fi
+
+php -f build.php

build/include/README.md

@@ -2,6 +2,8 @@
 
 ### Changelog:
 
+ - `0.1.9` maintenance release with fixes. added XMLReaderNode::expand().
+
  - `0.1.8` maintenance release with fixes.
 
  - `0.1.7` maintenance release with fixes.

build/include/xmlreader-iterators.php

@@ -19,7 +19,7 @@
  *
  * @author hakre <http://hakre.wordpress.com>
  * @license AGPL-3.0 <http://spdx.org/licenses/AGPL-3.0>
- * @version 0.1.8
+ * @version 0.1.9
  */
 
 /**
@@ -845,18 +845,42 @@ private function writeReaderImpl(XMLWriter $writer, XMLReader $reader) {
  */
 class XMLReaderNode implements XMLReaderAggregate
 {
-    public $name;
+    /** @var XMLReader */
     private $reader;
+
+    /** @var int */
     private $nodeType;
-    private $string;
-    private $attributes;
+
+    /** @var string */
+    private $name;
+
+    /** @var string */
+    private $localName;
+
+    /**
+     * cache for expansion into SimpleXMLElement
+     *
+     * @var null|SimpleXMLElement
+     * @see asSimpleXML
+     */
     private $simpleXML;
 
+    /**
+     * cache for XMLAttributeIterator
+     *
+     * @var null|XMLAttributeIterator
+     * @see getAttributes
+     */
+    private $attributes;
+
+    /** @var null|string  */
+    private $string;
+
     public function __construct(XMLReader $reader)
     {
-        $this->reader         = $reader;
-        $this->nodeType       = $reader->nodeType;
-        $this->name           = $reader->name;
+        $this->reader   = $reader;
+        $this->nodeType = $reader->nodeType;
+        $this->name     = $reader->name;
     }
 
     public function __toString()
@@ -876,13 +900,12 @@ public function __toString()
      */
     public function getSimpleXMLElement()
     {
-        if (null === $this->simpleXML)
-        {
+        if (null === $this->simpleXML) {
             if ($this->reader->nodeType !== XMLReader::ELEMENT) {
                 return null;
             }
 
-            $node = $this->getDocumentNode();
+            $node            = $this->expand();
             $this->simpleXML = simplexml_import_dom($node);
         }
 
@@ -897,6 +920,7 @@ public function getSimpleXMLElement()
     public function asSimpleXML()
     {
         trigger_error('Deprecated ' . __METHOD__ . '() - use getSimpleXMLElement() in the future', E_USER_NOTICE);
+
         return $this->getSimpleXMLElement();
     }
 
@@ -944,11 +968,22 @@ public function getChildren()
         return new XMLChildIterator($this->reader);
     }
 
+    /**
+     * @return string name
+     */
     public function getName()
     {
         return $this->name;
     }
 
+    /**
+     * @return string local name
+     */
+    public function getLocalName()
+    {
+        return $this->localName;
+    }
+
     public function getReader()
     {
         return $this->reader;
@@ -971,18 +1006,13 @@ public function readOuterXml()
             return '';
         }
 
-        $node = $this->getDocumentNode();
+        $doc = new DOMDocument();
+
+        $doc->preserveWhiteSpace = false;
+        $doc->formatOutput       = true;
+
+        $node = $this->expand($doc);
 
-        /**
-         * FIXME this var hint is un-necessary
-         *
-         * @link http://youtrack.jetbrains.com/issue/WI-23810
-         *
-         * @var $doc DOMDocument
-         */
-        $doc  = $node->ownerDocument;
-        $doc->formatOutput = true;
-        $node = $doc->appendChild($node);
         return $doc->saveXML($node);
     }
 
@@ -993,16 +1023,28 @@ public function readOuterXml()
      * or getting a SimpleXMLElement out of it @see getSimpleXMLElement
      *
      * @throws BadMethodCallException
-     *
+     * @param DOMNode $basenode
      * @return DOMNode
      */
-    private function getDocumentNode() {
-        if (false === $node = $this->reader->expand()) {
+    public function expand(DOMNode $basenode = null)
+    {
+        if (null === $basenode) {
+            $basenode = new DomDocument();
+        }
+
+        if ($basenode instanceof DOMDocument) {
+            $doc = $basenode;
+        } else {
+            $doc = $basenode->ownerDocument;
+        }
+
+        if (false === $node = $this->reader->expand($basenode)) {
             throw new BadMethodCallException('Unable to expand node.');
         }
 
-        $doc  = new DomDocument();
-        $node = $doc->importNode($node, true);
+        if ($node->ownerDocument !== $doc) {
+            $node = $doc->importNode($node, true);
+        }
 
         return $node;
     }
@@ -1089,7 +1131,7 @@ public function __get($name)
      *
      * @param XMLReader $reader
      * @param bool $return (optional) prints by default but can return string
-     * @return string
+     * @return string|null
      */
     public static function dump(XMLReader $reader, $return = FALSE)
     {
@@ -1136,6 +1178,8 @@ public static function dump(XMLReader $reader, $return = FALSE)
         }
 
         printf("%s%s\n", str_repeat('  ', $reader->depth), $label);
+
+        return null;
     }
 }
 
@@ -1961,6 +2005,7 @@ function __toString() {
  */
 class XMLSequenceStream
 {
+    const DECL_POS_PATTERN = '(<\?xml\s+version\s*=\s*(["\'])(1\.\d+)\1(?:\s*\?>|\s+encoding\s*=\s*(["\'])(((?!\3).)*)\3))';
     /**
      * @var resource
      */
@@ -2134,8 +2179,7 @@ public function stream_read($count)
 
     private function declPos($offset = 0)
     {
-        $declPattern = '(<\?xml\s+version\s*=\s*(["\'])(1\.\d+)\1\s+encoding\s*=\s*(["\'])(((?!\3).)*)\3)';
-        $result      = preg_match($declPattern, $this->reader->buffer, $matches, PREG_OFFSET_CAPTURE, $offset);
+        $result      = preg_match(self::DECL_POS_PATTERN, $this->reader->buffer, $matches, PREG_OFFSET_CAPTURE, $offset);
         if ($result === FALSE) {
             throw new UnexpectedValueException('Regex failed.');
         }

phpunit.xml.dist

@@ -3,6 +3,11 @@
          colors="false"
          bootstrap="tests/bootstrap.php"
         >
+    <testsuites>
+        <testsuite name="default">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
     <filter>
         <whitelist>
             <directory>./src/</directory>