Refactored the nodes into inner and leaf nodes

Author: paquettg

src/PHPHtmlParser/Dom/AbstractNode.php

@@ -2,7 +2,6 @@
 namespace PHPHtmlParser\Dom;
 
 use PHPHtmlParser\Selector;
-use PHPHtmlParser\Exceptions\ChildNotFoundException;
 use PHPHtmlParser\Exceptions\CircularException;
 use PHPHtmlParser\Exceptions\ParentNotFoundException;
 use stringEncode\Encode;
@@ -31,17 +30,10 @@ abstract class AbstractNode
      */
     protected $attr = [];
 
-    /**
-     * An array of all the children.
-     *
-     * @var array
-     */
-    protected $children = [];
-
     /**
      * Contains the parent Node.
      *
-     * @var AbstractNode
+     * @var InnerNode
      */
     protected $parent = null;
 
@@ -133,17 +125,12 @@ public function getParent()
     /**
      * Sets the parent node.
      *
-     * @param AbstractNode $parent
+     * @param InnerNode $parent
      * @return $this
      * @throws CircularException
      */
-    public function setParent(AbstractNode $parent)
+    public function setParent(InnerNode $parent)
     {
-        // check integrity
-        if ($this->isDescendant($parent->id())) {
-            throw new CircularException('Can not add descendant "'.$parent->id().'" as my parent.');
-        }
-
         // remove from old parent
         if ( ! is_null($this->parent)) {
             if ($this->parent->id() == $parent->id()) {
@@ -166,231 +153,15 @@ public function setParent(AbstractNode $parent)
     }
 
     /**
-     * Sets the encoding class to this node and propagates it
-     * to all its children.
+     * Sets the encoding class to this node.
      *
      * @param Encode $encode
+     * @return void
      */
     public function propagateEncoding(Encode $encode)
     {
         $this->encode = $encode;
         $this->tag->setEncoding($encode);
-        // check children
-        foreach ($this->children as $id => $child) {
-            /** @var AbstractNode $node */
-            $node = $child['node'];
-            $node->propagateEncoding($encode);
-        }
-    }
-
-    /**
-     * Checks if this node has children.
-     *
-     * @return bool
-     */
-    public function hasChildren()
-    {
-        return ! empty($this->children);
-    }
-
-    /**
-     * Returns the child by id.
-     *
-     * @param int $id
-     * @return AbstractNode
-     * @throws ChildNotFoundException
-     */
-    public function getChild($id)
-    {
-        if ( ! isset($this->children[$id])) {
-            throw new ChildNotFoundException("Child '$id' not found in this node.");
-        }
-
-        return $this->children[$id]['node'];
-    }
-
-    /**
-     * Returns a new array of child nodes
-     *
-     * @return array
-     */
-    public function getChildren()
-    {
-        $nodes = [];
-        try {
-            $child = $this->firstChild();
-            do {
-                $nodes[] = $child;
-                $child   = $this->nextChild($child->id());
-            } while ( ! is_null($child));
-        } catch (ChildNotFoundException $e) {
-            // we are done looking for children
-        }
-
-        return $nodes;
-    }
-
-    /**
-     * Counts children
-     *
-     * @return int
-     */
-    public function countChildren()
-    {
-        return count($this->children);
-    }
-
-    /**
-     * Adds a child node to this node and returns the id of the child for this
-     * parent.
-     *
-     * @param AbstractNode $child
-     * @return bool
-     * @throws CircularException
-     */
-    public function addChild(AbstractNode $child)
-    {
-        $key = null;
-
-        // check integrity
-        if ($this->isAncestor($child->id())) {
-            throw new CircularException('Can not add child. It is my ancestor.');
-        }
-
-        // check if child is itself
-        if ($child->id() == $this->id) {
-            throw new CircularException('Can not set itself as a child.');
-        }
-
-        if ($this->hasChildren()) {
-            if (isset($this->children[$child->id()])) {
-                // we already have this child
-                return false;
-            }
-            $sibling                      = $this->lastChild();
-            $key                          = $sibling->id();
-            $this->children[$key]['next'] = $child->id();
-        }
-
-        // add the child
-        $this->children[$child->id()] = [
-            'node' => $child,
-            'next' => null,
-            'prev' => $key,
-        ];
-
-        // tell child I am the new parent
-        $child->setParent($this);
-
-        //clear any cache
-        $this->clear();
-
-        return true;
-    }
-
-    /**
-     * Removes the child by id.
-     *
-     * @param int $id
-     * @return $this
-     */
-    public function removeChild($id)
-    {
-        if ( ! isset($this->children[$id])) {
-            return $this;
-        }
-
-        // handle moving next and previous assignments.
-        $next = $this->children[$id]['next'];
-        $prev = $this->children[$id]['prev'];
-        if ( ! is_null($next)) {
-            $this->children[$next]['prev'] = $prev;
-        }
-        if ( ! is_null($prev)) {
-            $this->children[$prev]['next'] = $next;
-        }
-
-        // remove the child
-        unset($this->children[$id]);
-
-        //clear any cache
-        $this->clear();
-
-        return $this;
-    }
-
-    /**
-     * Attempts to get the next child.
-     *
-     * @param int $id
-     * @return AbstractNode
-     * @uses $this->getChild()
-     */
-    public function nextChild($id)
-    {
-        $child = $this->getChild($id);
-        $next  = $this->children[$child->id()]['next'];
-
-        return $this->getChild($next);
-    }
-
-    /**
-     * Attempts to get the previous child.
-     *
-     * @param int $id
-     * @return AbstractNode
-     * @uses $this->getChild()
-     */
-    public function previousChild($id)
-    {
-        $child = $this->getchild($id);
-        $next  = $this->children[$child->id()]['prev'];
-
-        return $this->getChild($next);
-    }
-
-    /**
-     * Checks if the given node id is a child of the
-     * current node.
-     *
-     * @param int $id
-     * @return bool
-     */
-    public function isChild($id)
-    {
-        foreach ($this->children as $childId => $child) {
-            if ($id == $childId) {
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * Checks if the given node id is a descendant of the
-     * current node.
-     *
-     * @param int $id
-     * @return bool
-     */
-    public function isDescendant($id)
-    {
-        if ($this->isChild($id)) {
-            return true;
-        }
-
-        foreach ($this->children as $childId => $child) {
-            /** @var AbstractNode $node */
-            $node = $child['node'];
-            if ($node->hasChildren() &&
-                $node->isDescendant($id)
-            ) {
-                return true;
-            }
-        }
-
-        return false;
     }
 
     /**

src/PHPHtmlParser/Dom/ArrayNode.php

@@ -12,13 +12,6 @@
 abstract class ArrayNode extends AbstractNode implements IteratorAggregate, Countable
 {
 
-    /**
-     * Returns the array to be used the the iterator.
-     *
-     * @return array
-     */
-    abstract protected function getIteratorArray();
-
     /**
      * Gets the iterator
      *
@@ -39,4 +32,10 @@ public function count()
         return count($this->getIteratorArray());
     }
 
+    /**
+     * Returns the array to be used the the iterator.
+     *
+     * @return array
+     */
+    abstract protected function getIteratorArray();
 }

src/PHPHtmlParser/Dom/HtmlNode.php

@@ -9,7 +9,7 @@
  *
  * @package PHPHtmlParser\Dom
  */
-class HtmlNode extends ArrayNode
+class HtmlNode extends InnerNode
 {
 
     /**