Support read children without using "skipNextRead"

Author: Julian Wundrak

src/XMLChildElementIterator.php

@@ -53,6 +53,11 @@ class XMLChildElementIterator extends XMLElementIterator
      */
     private $name;
 
+    /**
+     * @var int
+     */
+    private $innerDepth;
+
     /**
      * @inheritdoc
      *
@@ -81,6 +86,11 @@ public function rewind()
             !$this->moveToNextByNodeType(XMLReader::ELEMENT);
         }
 
+        // handles e.g. <parent/> -> no children available
+        if ($this->reader->isEmptyElement) {
+            return;
+        }
+
         if ($this->stopDepth === null) {
             $this->stopDepth = $this->reader->depth;
         }
@@ -89,6 +99,7 @@ public function rewind()
         $result = $this->nextChildElementByName($this->name);
 
         $this->index = $result ? 0 : null;
+        $this->innerDepth = 1;
         $this->didRewind = true;
     }
 
@@ -160,15 +171,15 @@ private function nextChildElementByName($name = null)
             }
         }
 
-        return (bool)$next;
+        return $next;
     }
 
     /**
      * @return bool
      */
     private function nextElement()
     {
-        while ($this->reader->read()) {
+        while ($this->readNext()) {
             if (XMLReader::ELEMENT !== $this->reader->nodeType) {
                 continue;
             }
@@ -177,4 +188,28 @@ private function nextElement()
         }
         return false;
     }
+
+    /**
+     * Wrap reading to track opening and closing tags to prevent reading not-children nodes
+     *
+     * @return bool
+     */
+    protected function readNext()
+    {
+        // update inner depth
+        if ($this->reader->nodeType === XMLReader::ELEMENT && !$this->reader->isEmptyElement) {
+            $this->innerDepth++;
+        } elseif ($this->reader->nodeType === XMLReader::END_ELEMENT) {
+            $this->innerDepth--;
+
+            // all children read? Abort to prevent reading next node
+            if ($this->innerDepth === 0) {
+                // set pointer behind closing-tag
+                parent::readNext();
+                return false;
+            }
+        }
+
+        return parent::readNext();
+    }
 }

src/XMLReaderIterator.php

@@ -167,11 +167,17 @@ public function next()
         if ($this->skipNextRead) {
             $this->skipNextRead = false;
             $this->lastRead = $this->reader->nodeType !== XMLReader::NONE;
-        } elseif ($this->lastRead = $this->reader->read() and $this->reader->nodeType === XMLReader::ELEMENT) {
+        } elseif ($this->lastRead = $this->readNext() and $this->reader->nodeType === XMLReader::ELEMENT) {
             $this->touchElementStack();
         }
     }
 
+    #[\ReturnTypeWillChange]
+    protected function readNext()
+    {
+        return $this->reader->read();
+    }
+
     /**
      * @return string
      * @since 0.0.19