paquettg / php-html-parser

src/PHPHtmlParser/Dom/AbstractNode.php

Indentation +389 added lines, -389 removed lines

@@ -18,393 +18,393 @@
 abstract class AbstractNode
 {
 
-    /**
-     * Contains the tag name/type
-     *
-     * @var \PHPHtmlParser\Dom\Tag
-     */
-    protected $tag;
-
-    /**
-     * Contains a list of attributes on this tag.
-     *
-     * @var array
-     */
-    protected $attr = [];
-
-    /**
-     * Contains the parent Node.
-     *
-     * @var InnerNode
-     */
-    protected $parent = null;
-
-    /**
-     * The unique id of the class. Given by PHP.
-     *
-     * @var string
-     */
-    protected $id;
-
-    /**
-     * The encoding class used to encode strings.
-     *
-     * @var mixed
-     */
-    protected $encode;
-
-    /**
-     * Creates a unique spl hash for this node.
-     */
-    public function __construct()
-    {
-        $this->id = spl_object_hash($this);
-    }
-
-    /**
-     * Magic get method for attributes and certain methods.
-     *
-     * @param string $key
-     * @return mixed
-     */
-    public function __get($key)
-    {
-        // check attribute first
-        if ( ! is_null($this->getAttribute($key))) {
-            return $this->getAttribute($key);
-        }
-        switch (strtolower($key)) {
-            case 'outerhtml':
-                return $this->outerHtml();
-            case 'innerhtml':
-                return $this->innerHtml();
-            case 'text':
-                return $this->text();
-            case 'tag':
-                return $this->getTag();
-            case 'parent':
-                $this->getParent();
-        }
-
-        return null;
-    }
-
-    /**
-     * Attempts to clear out any object references.
-     */
-    public function __destruct()
-    {
-        $this->tag      = null;
-        $this->attr     = [];
-        $this->parent   = null;
-        $this->children = [];
-    }
-
-    /**
-     * Simply calls the outer text method.
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->outerHtml();
-    }
-
-    /**
-     * Returns the id of this object.
-     */
-    public function id()
-    {
-        return $this->id;
-    }
-
-    /**
-     * Returns the parent of node.
-     *
-     * @return AbstractNode
-     */
-    public function getParent()
-    {
-        return $this->parent;
-    }
-
-    /**
-     * Sets the parent node.
-     *
-     * @param InnerNode $parent
-     * @return $this
-     * @throws CircularException
-     */
-    public function setParent(InnerNode $parent)
-    {
-        // remove from old parent
-        if ( ! is_null($this->parent)) {
-            if ($this->parent->id() == $parent->id()) {
-                // already the parent
-                return $this;
-            }
-
-            $this->parent->removeChild($this->id);
-        }
-
-        $this->parent = $parent;
-
-        // assign child to parent
-        $this->parent->addChild($this);
-
-        //clear any cache
-        $this->clear();
-
-        return $this;
-    }
-
-    /**
-     * Removes this node and all its children from the
-     * DOM tree.
-     *
-     * @return void
-     */
-    public function delete()
-    {
-        if ( ! is_null($this->parent)) {
-            $this->parent->removeChild($this->id);
-        }
-
-        $this->parent = null;
-    }
-
-    /**
-     * Sets the encoding class to this node.
-     *
-     * @param Encode $encode
-     * @return void
-     */
-    public function propagateEncoding(Encode $encode)
-    {
-        $this->encode = $encode;
-        $this->tag->setEncoding($encode);
-    }
-
-    /**
-     * Checks if the given node id is an ancestor of
-     * the current node.
-     *
-     * @param int $id
-     * @return bool
-     */
-    public function isAncestor($id)
-    {
-        if ( ! is_null($this->getAncestor($id))) {
-            return true;
-        }
-
-        return false;
-    }
-
-    /**
-     * Attempts to get an ancestor node by the given id.
-     *
-     * @param int $id
-     * @return null|AbstractNode
-     */
-    public function getAncestor($id)
-    {
-        if ( ! is_null($this->parent)) {
-            if ($this->parent->id() == $id) {
-                return $this->parent;
-            }
-
-            return $this->parent->getAncestor($id);
-        }
-
-        return null;
-    }
-
-    /**
-     * Attempts to get the next sibling.
-     *
-     * @return AbstractNode
-     * @throws ParentNotFoundException
-     */
-    public function nextSibling()
-    {
-        if (is_null($this->parent)) {
-            throw new ParentNotFoundException('Parent is not set for this node.');
-        }
-
-        return $this->parent->nextChild($this->id);
-    }
-
-    /**
-     * Attempts to get the previous sibling
-     *
-     * @return AbstractNode
-     * @throws ParentNotFoundException
-     */
-    public function previousSibling()
-    {
-        if (is_null($this->parent)) {
-            throw new ParentNotFoundException('Parent is not set for this node.');
-        }
-
-        return $this->parent->previousChild($this->id);
-    }
-
-    /**
-     * Gets the tag object of this node.
-     *
-     * @return Tag
-     */
-    public function getTag()
-    {
-        return $this->tag;
-    }
-
-    /**
-     * A wrapper method that simply calls the getAttribute method
-     * on the tag of this node.
-     *
-     * @return array
-     */
-    public function getAttributes()
-    {
-        $attributes = $this->tag->getAttributes();
-        foreach ($attributes as $name => $info) {
-            $attributes[$name] = $info['value'];
-        }
-
-        return $attributes;
-    }
-
-    /**
-     * A wrapper method that simply calls the getAttribute method
-     * on the tag of this node.
-     *
-     * @param string $key
-     * @return mixed
-     */
-    public function getAttribute($key)
-    {
-        $attribute = $this->tag->getAttribute($key);
-        if ( ! is_null($attribute)) {
-            $attribute = $attribute['value'];
-        }
-
-        return $attribute;
-    }
-
-    /**
-     * A wrapper method that simply calls the setAttribute method
-     * on the tag of this node.
-     *
-     * @param string $key
-     * @param string $value
-     * @return $this
-     */
-    public function setAttribute($key, $value)
-    {
-        $this->tag->setAttribute($key, $value);
-
-        return $this;
-    }
-
-    /**
-     * A wrapper method that simply calls the removeAttribute method
-     * on the tag of this node.
-     *
-     * @param string $key
-     * @return void
-     */
-    public function removeAttribute($key)
-    {
-        $this->tag->removeAttribute($key);
-    }
-
-    /**
-     * A wrapper method that simply calls the removeAllAttributes
-     * method on the tag of this node.
-     *
-     * @return void
-     */
-    public function removeAllAttributes()
-    {
-        $this->tag->removeAllAttributes();
-    }
-
-    /**
-     * Function to locate a specific ancestor tag in the path to the root.
-     *
-     * @param  string $tag
-     * @return AbstractNode
-     * @throws ParentNotFoundException
-     */
-    public function ancestorByTag($tag)
-    {
-        // Start by including ourselves in the comparison.
-        $node = $this;
-
-        while ( ! is_null($node)) {
-            if ($node->tag->name() == $tag) {
-                return $node;
-            }
-
-            $node = $node->getParent();
-        }
-
-        throw new ParentNotFoundException('Could not find an ancestor with "'.$tag.'" tag');
-    }
-
-    /**
-     * Find elements by css selector
-     *
-     * @param string $selector
-     * @param int $nth
-     * @return array|AbstractNode
-     */
-    public function find($selector, $nth = null)
-    {
-        $selector = new Selector($selector);
-        $nodes    = $selector->find($this);
-
-        if ( ! is_null($nth)) {
-            // return nth-element or array
-            if (isset($nodes[$nth])) {
-                return $nodes[$nth];
-            }
-
-            return null;
-        }
-
-        return $nodes;
-    }
-
-    /**
-     * Gets the inner html of this node.
-     *
-     * @return string
-     */
-    abstract public function innerHtml();
-
-    /**
-     * Gets the html of this node, including it's own
-     * tag.
-     *
-     * @return string
-     */
-    abstract public function outerHtml();
-
-    /**
-     * Gets the text of this node (if there is any text).
-     *
-     * @return string
-     */
-    abstract public function text();
-
-    /**
-     * Call this when something in the node tree has changed. Like a child has been added
-     * or a parent has been changed.
-     *
-     * @return void
-     */
-    abstract protected function clear();
+	/**
+	 * Contains the tag name/type
+	 *
+	 * @var \PHPHtmlParser\Dom\Tag
+	 */
+	protected $tag;
+
+	/**
+	 * Contains a list of attributes on this tag.
+	 *
+	 * @var array
+	 */
+	protected $attr = [];
+
+	/**
+	 * Contains the parent Node.
+	 *
+	 * @var InnerNode
+	 */
+	protected $parent = null;
+
+	/**
+	 * The unique id of the class. Given by PHP.
+	 *
+	 * @var string
+	 */
+	protected $id;
+
+	/**
+	 * The encoding class used to encode strings.
+	 *
+	 * @var mixed
+	 */
+	protected $encode;
+
+	/**
+	 * Creates a unique spl hash for this node.
+	 */
+	public function __construct()
+	{
+		$this->id = spl_object_hash($this);
+	}
+
+	/**
+	 * Magic get method for attributes and certain methods.
+	 *
+	 * @param string $key
+	 * @return mixed
+	 */
+	public function __get($key)
+	{
+		// check attribute first
+		if ( ! is_null($this->getAttribute($key))) {
+			return $this->getAttribute($key);
+		}
+		switch (strtolower($key)) {
+			case 'outerhtml':
+				return $this->outerHtml();
+			case 'innerhtml':
+				return $this->innerHtml();
+			case 'text':
+				return $this->text();
+			case 'tag':
+				return $this->getTag();
+			case 'parent':
+				$this->getParent();
+		}
+
+		return null;
+	}
+
+	/**
+	 * Attempts to clear out any object references.
+	 */
+	public function __destruct()
+	{
+		$this->tag      = null;
+		$this->attr     = [];
+		$this->parent   = null;
+		$this->children = [];
+	}
+
+	/**
+	 * Simply calls the outer text method.
+	 *
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->outerHtml();
+	}
+
+	/**
+	 * Returns the id of this object.
+	 */
+	public function id()
+	{
+		return $this->id;
+	}
+
+	/**
+	 * Returns the parent of node.
+	 *
+	 * @return AbstractNode
+	 */
+	public function getParent()
+	{
+		return $this->parent;
+	}
+
+	/**
+	 * Sets the parent node.
+	 *
+	 * @param InnerNode $parent
+	 * @return $this
+	 * @throws CircularException
+	 */
+	public function setParent(InnerNode $parent)
+	{
+		// remove from old parent
+		if ( ! is_null($this->parent)) {
+			if ($this->parent->id() == $parent->id()) {
+				// already the parent
+				return $this;
+			}
+
+			$this->parent->removeChild($this->id);
+		}
+
+		$this->parent = $parent;
+
+		// assign child to parent
+		$this->parent->addChild($this);
+
+		//clear any cache
+		$this->clear();
+
+		return $this;
+	}
+
+	/**
+	 * Removes this node and all its children from the
+	 * DOM tree.
+	 *
+	 * @return void
+	 */
+	public function delete()
+	{
+		if ( ! is_null($this->parent)) {
+			$this->parent->removeChild($this->id);
+		}
+
+		$this->parent = null;
+	}
+
+	/**
+	 * Sets the encoding class to this node.
+	 *
+	 * @param Encode $encode
+	 * @return void
+	 */
+	public function propagateEncoding(Encode $encode)
+	{
+		$this->encode = $encode;
+		$this->tag->setEncoding($encode);
+	}
+
+	/**
+	 * Checks if the given node id is an ancestor of
+	 * the current node.
+	 *
+	 * @param int $id
+	 * @return bool
+	 */
+	public function isAncestor($id)
+	{
+		if ( ! is_null($this->getAncestor($id))) {
+			return true;
+		}
+
+		return false;
+	}
+
+	/**
+	 * Attempts to get an ancestor node by the given id.
+	 *
+	 * @param int $id
+	 * @return null|AbstractNode
+	 */
+	public function getAncestor($id)
+	{
+		if ( ! is_null($this->parent)) {
+			if ($this->parent->id() == $id) {
+				return $this->parent;
+			}
+
+			return $this->parent->getAncestor($id);
+		}
+
+		return null;
+	}
+
+	/**
+	 * Attempts to get the next sibling.
+	 *
+	 * @return AbstractNode
+	 * @throws ParentNotFoundException
+	 */
+	public function nextSibling()
+	{
+		if (is_null($this->parent)) {
+			throw new ParentNotFoundException('Parent is not set for this node.');
+		}
+
+		return $this->parent->nextChild($this->id);
+	}
+
+	/**
+	 * Attempts to get the previous sibling
+	 *
+	 * @return AbstractNode
+	 * @throws ParentNotFoundException
+	 */
+	public function previousSibling()
+	{
+		if (is_null($this->parent)) {
+			throw new ParentNotFoundException('Parent is not set for this node.');
+		}
+
+		return $this->parent->previousChild($this->id);
+	}
+
+	/**
+	 * Gets the tag object of this node.
+	 *
+	 * @return Tag
+	 */
+	public function getTag()
+	{
+		return $this->tag;
+	}
+
+	/**
+	 * A wrapper method that simply calls the getAttribute method
+	 * on the tag of this node.
+	 *
+	 * @return array
+	 */
+	public function getAttributes()
+	{
+		$attributes = $this->tag->getAttributes();
+		foreach ($attributes as $name => $info) {
+			$attributes[$name] = $info['value'];
+		}
+
+		return $attributes;
+	}
+
+	/**
+	 * A wrapper method that simply calls the getAttribute method
+	 * on the tag of this node.
+	 *
+	 * @param string $key
+	 * @return mixed
+	 */
+	public function getAttribute($key)
+	{
+		$attribute = $this->tag->getAttribute($key);
+		if ( ! is_null($attribute)) {
+			$attribute = $attribute['value'];
+		}
+
+		return $attribute;
+	}
+
+	/**
+	 * A wrapper method that simply calls the setAttribute method
+	 * on the tag of this node.
+	 *
+	 * @param string $key
+	 * @param string $value
+	 * @return $this
+	 */
+	public function setAttribute($key, $value)
+	{
+		$this->tag->setAttribute($key, $value);
+
+		return $this;
+	}
+
+	/**
+	 * A wrapper method that simply calls the removeAttribute method
+	 * on the tag of this node.
+	 *
+	 * @param string $key
+	 * @return void
+	 */
+	public function removeAttribute($key)
+	{
+		$this->tag->removeAttribute($key);
+	}
+
+	/**
+	 * A wrapper method that simply calls the removeAllAttributes
+	 * method on the tag of this node.
+	 *
+	 * @return void
+	 */
+	public function removeAllAttributes()
+	{
+		$this->tag->removeAllAttributes();
+	}
+
+	/**
+	 * Function to locate a specific ancestor tag in the path to the root.
+	 *
+	 * @param  string $tag
+	 * @return AbstractNode
+	 * @throws ParentNotFoundException
+	 */
+	public function ancestorByTag($tag)
+	{
+		// Start by including ourselves in the comparison.
+		$node = $this;
+
+		while ( ! is_null($node)) {
+			if ($node->tag->name() == $tag) {
+				return $node;
+			}
+
+			$node = $node->getParent();
+		}
+
+		throw new ParentNotFoundException('Could not find an ancestor with "'.$tag.'" tag');
+	}
+
+	/**
+	 * Find elements by css selector
+	 *
+	 * @param string $selector
+	 * @param int $nth
+	 * @return array|AbstractNode
+	 */
+	public function find($selector, $nth = null)
+	{
+		$selector = new Selector($selector);
+		$nodes    = $selector->find($this);
+
+		if ( ! is_null($nth)) {
+			// return nth-element or array
+			if (isset($nodes[$nth])) {
+				return $nodes[$nth];
+			}
+
+			return null;
+		}
+
+		return $nodes;
+	}
+
+	/**
+	 * Gets the inner html of this node.
+	 *
+	 * @return string
+	 */
+	abstract public function innerHtml();
+
+	/**
+	 * Gets the html of this node, including it's own
+	 * tag.
+	 *
+	 * @return string
+	 */
+	abstract public function outerHtml();
+
+	/**
+	 * Gets the text of this node (if there is any text).
+	 *
+	 * @return string
+	 */
+	abstract public function text();
+
+	/**
+	 * Call this when something in the node tree has changed. Like a child has been added
+	 * or a parent has been changed.
+	 *
+	 * @return void
+	 */
+	abstract protected function clear();
 }

src/PHPHtmlParser/Dom/InnerNode.php

Indentation +301 added lines, -301 removed lines

@@ -13,305 +13,305 @@
 abstract class InnerNode extends ArrayNode
 {
 
-    /**
-     * An array of all the children.
-     *
-     * @var array
-     */
-    protected $children = [];
-
-    /**
-     * Sets the encoding class to this node and propagates it
-     * to all its children.
-     *
-     * @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()
-     * @throws ChildNotFoundException
-     */
-    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()
-     * @throws ChildNotFoundException
-     */
-    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;
-    }
-
-    /**
-     * Removes the child with id $childId and replace it with the new child
-     * $newChild.
-     *
-     * @param int $childId
-     * @param AbstractNode $newChild
-     * @throws ChildNotFoundException
-     */
-    public function replaceChild($childId, AbstractNode $newChild)
-    {
-        $oldChild                        = $this->getChild($childId);
-        $keys                            = array_keys($this->children);
-        $index                           = array_search($childId, $keys, true);
-        $keys[$index]                    = $newChild->id();
-        $this->children                  = array_combine($keys, $this->children);
-        $this->children[$newChild->id()] = $newChild;
-        unset($oldChild);
-    }
-
-    /**
-     * Shortcut to return the first child.
-     *
-     * @return AbstractNode
-     * @uses $this->getChild()
-     */
-    public function firstChild()
-    {
-        reset($this->children);
-        $key = key($this->children);
-
-        return $this->getChild($key);
-    }
-
-    /**
-     * Attempts to get the last child.
-     *
-     * @return AbstractNode
-     */
-    public function lastChild()
-    {
-        end($this->children);
-        $key = key($this->children);
-
-        return $this->getChild($key);
-    }
-
-    /**
-     * 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 InnerNode $node */
-            $node = $child['node'];
-            if ($node instanceof InnerNode &&
-                $node->hasChildren() &&
-                $node->isDescendant($id)
-            ) {
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * Sets the parent node.
-     *
-     * @param InnerNode $parent
-     * @return $this
-     * @throws CircularException
-     */
-    public function setParent(InnerNode $parent)
-    {
-        // check integrity
-        if ($this->isDescendant($parent->id())) {
-            throw new CircularException('Can not add descendant "'.$parent->id().'" as my parent.');
-        }
-
-        return parent::setParent($parent);
-    }
+	/**
+	 * An array of all the children.
+	 *
+	 * @var array
+	 */
+	protected $children = [];
+
+	/**
+	 * Sets the encoding class to this node and propagates it
+	 * to all its children.
+	 *
+	 * @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()
+	 * @throws ChildNotFoundException
+	 */
+	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()
+	 * @throws ChildNotFoundException
+	 */
+	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;
+	}
+
+	/**
+	 * Removes the child with id $childId and replace it with the new child
+	 * $newChild.
+	 *
+	 * @param int $childId
+	 * @param AbstractNode $newChild
+	 * @throws ChildNotFoundException
+	 */
+	public function replaceChild($childId, AbstractNode $newChild)
+	{
+		$oldChild                        = $this->getChild($childId);
+		$keys                            = array_keys($this->children);
+		$index                           = array_search($childId, $keys, true);
+		$keys[$index]                    = $newChild->id();
+		$this->children                  = array_combine($keys, $this->children);
+		$this->children[$newChild->id()] = $newChild;
+		unset($oldChild);
+	}
+
+	/**
+	 * Shortcut to return the first child.
+	 *
+	 * @return AbstractNode
+	 * @uses $this->getChild()
+	 */
+	public function firstChild()
+	{
+		reset($this->children);
+		$key = key($this->children);
+
+		return $this->getChild($key);
+	}
+
+	/**
+	 * Attempts to get the last child.
+	 *
+	 * @return AbstractNode
+	 */
+	public function lastChild()
+	{
+		end($this->children);
+		$key = key($this->children);
+
+		return $this->getChild($key);
+	}
+
+	/**
+	 * 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 InnerNode $node */
+			$node = $child['node'];
+			if ($node instanceof InnerNode &&
+				$node->hasChildren() &&
+				$node->isDescendant($id)
+			) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * Sets the parent node.
+	 *
+	 * @param InnerNode $parent
+	 * @return $this
+	 * @throws CircularException
+	 */
+	public function setParent(InnerNode $parent)
+	{
+		// check integrity
+		if ($this->isDescendant($parent->id())) {
+			throw new CircularException('Can not add descendant "'.$parent->id().'" as my parent.');
+		}
+
+		return parent::setParent($parent);
+	}
 }
\ No newline at end of file

src/PHPHtmlParser/Selector.php

Indentation +360 added lines, -360 removed lines

@@ -15,364 +15,364 @@
 class Selector
 {
 
-    /**
-     * Pattern of CSS selectors, modified from 'mootools'
-     *
-     * @var string
-     */
-    protected $pattern = "/([\w-:\*>]*)(?:\#([\w-]+)|\.([\w-]+))?(?:\[@?(!?[\w-:]+)(?:([!*^$]?=)[\"']?(.*?)[\"']?)?\])?([\/, ]+)/is";
-
-    protected $selectors = [];
-
-    /**
-     * Constructs with the selector string
-     *
-     * @param string $selector
-     */
-    public function __construct($selector)
-    {
-        $this->parseSelectorString($selector);
-    }
-
-    /**
-     * Returns the selectors that where found in __construct
-     *
-     * @return array
-     */
-    public function getSelectors()
-    {
-        return $this->selectors;
-    }
-
-    /**
-     * Attempts to find the selectors starting from the given
-     * node object.
-     *
-     * @param AbstractNode $node
-     * @return array|Collection
-     */
-    public function find(AbstractNode $node)
-    {
-        $results = new Collection;
-        foreach ($this->selectors as $selector) {
-            $nodes = [$node];
-            if (count($selector) == 0) {
-                continue;
-            }
-
-            $options = [];
-            foreach ($selector as $rule) {
-                if ($rule['alterNext']) {
-                    $options[] = $this->alterNext($rule);
-                    continue;
-                }
-                $nodes = $this->seek($nodes, $rule, $options);
-                // clear the options
-                $options = [];
-            }
-
-            // this is the final set of nodes
-            foreach ($nodes as $result) {
-                $results[] = $result;
-            }
-        }
-
-        return $results;
-    }
-
-    /**
-     * Parses the selector string
-     *
-     * @param string $selector
-     */
-    protected function parseSelectorString($selector)
-    {
-        $matches = [];
-        preg_match_all($this->pattern, trim($selector).' ', $matches, PREG_SET_ORDER);
-
-        // skip tbody
-        $result = [];
-        foreach ($matches as $match) {
-            // default values
-            $tag       = strtolower(trim($match[1]));
-            $operator  = '=';
-            $key       = null;
-            $value     = null;
-            $noKey     = false;
-            $alterNext = false;
-
-            // check for elements that alter the behavior of the next element
-            if ($tag == '>') {
-                $alterNext = true;
-            }
-
-            // check for id selector
-            if ( ! empty($match[2])) {
-                $key   = 'id';
-                $value = $match[2];
-            }
-
-            // check for class selector
-            if ( ! empty($match[3])) {
-                $key   = 'class';
-                $value = $match[3];
-            }
-
-            // and final attribute selector
-            if ( ! empty($match[4])) {
-                $key = strtolower($match[4]);
-            }
-            if ( ! empty($match[5])) {
-                $operator = $match[5];
-            }
-            if ( ! empty($match[6])) {
-                $value = $match[6];
-            }
-
-            // check for elements that do not have a specified attribute
-            if (isset($key[0]) && $key[0] == '!') {
-                $key   = substr($key, 1);
-                $noKey = true;
-            }
-
-            $result[] = [
-                'tag'       => $tag,
-                'key'       => $key,
-                'value'     => $value,
-                'operator'  => $operator,
-                'noKey'     => $noKey,
-                'alterNext' => $alterNext,
-            ];
-            if (trim($match[7]) == ',') {
-                $this->selectors[] = $result;
-                $result            = [];
-            }
-        }
-
-        // save last results
-        if (count($result) > 0) {
-            $this->selectors[] = $result;
-        }
-    }
-
-    /**
-     * Attempts to find all children that match the rule
-     * given.
-     *
-     * @param array $nodes
-     * @param array $rule
-     * @param array $options
-     * @return array
-     * @recursive
-     */
-    protected function seek(array $nodes, array $rule, array $options)
-    {
-        // XPath index
-        if (count($rule['tag']) > 0 &&
-            count($rule['key']) > 0 &&
-            is_numeric($rule['key'])
-        ) {
-            $count = 0;
-            /** @var AbstractNode $node */
-            foreach ($nodes as $node) {
-                if ($rule['tag'] == '*' ||
-                    $rule['tag'] == $node->getTag()->name()
-                ) {
-                    ++$count;
-                    if ($count == $rule['key']) {
-                        // found the node we wanted
-                        return [$node];
-                    }
-                }
-            }
-
-            return [];
-        }
-
-        $options = $this->flattenOptions($options);
-
-        $return = [];
-        /** @var InnerNode $node */
-        foreach ($nodes as $node) {
-            // check if we are a leaf
-            if ($node instanceof LeafNode ||
-                ! $node->hasChildren()
-            ) {
-                continue;
-            }
-
-            $children = [];
-            $child    = $node->firstChild();
-            while ( ! is_null($child)) {
-                // wild card, grab all
-                if ($rule['tag'] == '*' && is_null($rule['key'])) {
-                    $return[] = $child;
-                    try {
-                        $child = $node->nextChild($child->id());
-                    } catch (ChildNotFoundException $e) {
-                        // no more children
-                        $child = null;
-                    }
-                    continue;
-                }
-
-                $pass = true;
-                // check tag
-                if ( ! empty($rule['tag']) && $rule['tag'] != $child->getTag()->name() &&
-                    $rule['tag'] != '*'
-                ) {
-                    // child failed tag check
-                    $pass = false;
-                }
-
-                // check key
-                if ($pass && ! is_null($rule['key'])) {
-                    if ($rule['noKey']) {
-                        if ( ! is_null($child->getAttribute($rule['key']))) {
-                            $pass = false;
-                        }
-                    } else {
-                        if ($rule['key'] != 'plaintext' &&
-                            is_null($child->getAttribute($rule['key']))
-                        ) {
-                            $pass = false;
-                        }
-                    }
-                }
-
-                // compare values
-                if ($pass && ! is_null($rule['key']) &&
-                    ! is_null($rule['value']) && $rule['value'] != '*'
-                ) {
-                    if ($rule['key'] == 'plaintext') {
-                        // plaintext search
-                        $nodeValue = $child->text();
-                    } else {
-                        // normal search
-                        $nodeValue = $child->getAttribute($rule['key']);
-                    }
-
-                    $check = $this->match($rule['operator'], $rule['value'], $nodeValue);
-
-                    // handle multiple classes
-                    if ( ! $check && $rule['key'] == 'class') {
-                        $childClasses = explode(' ', $child->getAttribute('class'));
-                        foreach ($childClasses as $class) {
-                            if ( ! empty($class)) {
-                                $check = $this->match($rule['operator'], $rule['value'], $class);
-                            }
-                            if ($check) {
-                                break;
-                            }
-                        }
-                    }
-
-                    if ( ! $check) {
-                        $pass = false;
-                    }
-                }
-
-                if ($pass) {
-                    // it passed all checks
-                    $return[] = $child;
-                } else {
-                    // this child failed to be matched
-                    if ($child instanceof InnerNode &&
-                        $child->hasChildren()
-                    ) {
-                        // we still want to check its children
-                        $children[] = $child;
-                    }
-                }
-
-                try {
-                    // get next child
-                    $child = $node->nextChild($child->id());
-                } catch (ChildNotFoundException $e) {
-                    // no more children
-                    $child = null;
-                }
-            }
-
-            if (( ! isset($options['checkGrandChildren']) ||
-                    $options['checkGrandChildren'])
-                && count($children) > 0
-            ) {
-                // we have children that failed but are not leaves.
-                $matches = $this->seek($children, $rule, $options);
-                foreach ($matches as $match) {
-                    $return[] = $match;
-                }
-            }
-        }
-
-        return $return;
-    }
-
-    /**
-     * Attempts to match the given arguments with the given operator.
-     *
-     * @param string $operator
-     * @param string $pattern
-     * @param string $value
-     * @return bool
-     */
-    protected function match($operator, $pattern, $value)
-    {
-        $value   = strtolower($value);
-        $pattern = strtolower($pattern);
-        switch ($operator) {
-            case '=':
-                return $value === $pattern;
-            case '!=':
-                return $value !== $pattern;
-            case '^=':
-                return preg_match('/^'.preg_quote($pattern, '/').'/', $value);
-            case '$=':
-                return preg_match('/'.preg_quote($pattern, '/').'$/', $value);
-            case '*=':
-                if ($pattern[0] == '/') {
-                    return preg_match($pattern, $value);
-                }
-
-                return preg_match("/".$pattern."/i", $value);
-        }
-
-        return false;
-    }
-
-    /**
-     * Attempts to figure out what the alteration will be for
-     * the next element.
-     *
-     * @param array $rule
-     * @return array
-     */
-    protected function alterNext($rule)
-    {
-        $options = [];
-        if ($rule['tag'] == '>') {
-            $options['checkGrandChildren'] = false;
-        }
-
-        return $options;
-    }
-
-    /**
-     * Flattens the option array.
-     *
-     * @param array $optionsArray
-     * @return array
-     */
-    protected function flattenOptions(array $optionsArray)
-    {
-        $options = [];
-        foreach ($optionsArray as $optionArray) {
-            foreach ($optionArray as $key => $option) {
-                $options[$key] = $option;
-            }
-        }
-
-        return $options;
-    }
+	/**
+	 * Pattern of CSS selectors, modified from 'mootools'
+	 *
+	 * @var string
+	 */
+	protected $pattern = "/([\w-:\*>]*)(?:\#([\w-]+)|\.([\w-]+))?(?:\[@?(!?[\w-:]+)(?:([!*^$]?=)[\"']?(.*?)[\"']?)?\])?([\/, ]+)/is";
+
+	protected $selectors = [];
+
+	/**
+	 * Constructs with the selector string
+	 *
+	 * @param string $selector
+	 */
+	public function __construct($selector)
+	{
+		$this->parseSelectorString($selector);
+	}
+
+	/**
+	 * Returns the selectors that where found in __construct
+	 *
+	 * @return array
+	 */
+	public function getSelectors()
+	{
+		return $this->selectors;
+	}
+
+	/**
+	 * Attempts to find the selectors starting from the given
+	 * node object.
+	 *
+	 * @param AbstractNode $node
+	 * @return array|Collection
+	 */
+	public function find(AbstractNode $node)
+	{
+		$results = new Collection;
+		foreach ($this->selectors as $selector) {
+			$nodes = [$node];
+			if (count($selector) == 0) {
+				continue;
+			}
+
+			$options = [];
+			foreach ($selector as $rule) {
+				if ($rule['alterNext']) {
+					$options[] = $this->alterNext($rule);
+					continue;
+				}
+				$nodes = $this->seek($nodes, $rule, $options);
+				// clear the options
+				$options = [];
+			}
+
+			// this is the final set of nodes
+			foreach ($nodes as $result) {
+				$results[] = $result;
+			}
+		}
+
+		return $results;
+	}
+
+	/**
+	 * Parses the selector string
+	 *
+	 * @param string $selector
+	 */
+	protected function parseSelectorString($selector)
+	{
+		$matches = [];
+		preg_match_all($this->pattern, trim($selector).' ', $matches, PREG_SET_ORDER);
+
+		// skip tbody
+		$result = [];
+		foreach ($matches as $match) {
+			// default values
+			$tag       = strtolower(trim($match[1]));
+			$operator  = '=';
+			$key       = null;
+			$value     = null;
+			$noKey     = false;
+			$alterNext = false;
+
+			// check for elements that alter the behavior of the next element
+			if ($tag == '>') {
+				$alterNext = true;
+			}
+
+			// check for id selector
+			if ( ! empty($match[2])) {
+				$key   = 'id';
+				$value = $match[2];
+			}
+
+			// check for class selector
+			if ( ! empty($match[3])) {
+				$key   = 'class';
+				$value = $match[3];
+			}
+
+			// and final attribute selector
+			if ( ! empty($match[4])) {
+				$key = strtolower($match[4]);
+			}
+			if ( ! empty($match[5])) {
+				$operator = $match[5];
+			}
+			if ( ! empty($match[6])) {
+				$value = $match[6];
+			}
+
+			// check for elements that do not have a specified attribute
+			if (isset($key[0]) && $key[0] == '!') {
+				$key   = substr($key, 1);
+				$noKey = true;
+			}
+
+			$result[] = [
+				'tag'       => $tag,
+				'key'       => $key,
+				'value'     => $value,
+				'operator'  => $operator,
+				'noKey'     => $noKey,
+				'alterNext' => $alterNext,
+			];
+			if (trim($match[7]) == ',') {
+				$this->selectors[] = $result;
+				$result            = [];
+			}
+		}
+
+		// save last results
+		if (count($result) > 0) {
+			$this->selectors[] = $result;
+		}
+	}
+
+	/**
+	 * Attempts to find all children that match the rule
+	 * given.
+	 *
+	 * @param array $nodes
+	 * @param array $rule
+	 * @param array $options
+	 * @return array
+	 * @recursive
+	 */
+	protected function seek(array $nodes, array $rule, array $options)
+	{
+		// XPath index
+		if (count($rule['tag']) > 0 &&
+			count($rule['key']) > 0 &&
+			is_numeric($rule['key'])
+		) {
+			$count = 0;
+			/** @var AbstractNode $node */
+			foreach ($nodes as $node) {
+				if ($rule['tag'] == '*' ||
+					$rule['tag'] == $node->getTag()->name()
+				) {
+					++$count;
+					if ($count == $rule['key']) {
+						// found the node we wanted
+						return [$node];
+					}
+				}
+			}
+
+			return [];
+		}
+
+		$options = $this->flattenOptions($options);
+
+		$return = [];
+		/** @var InnerNode $node */
+		foreach ($nodes as $node) {
+			// check if we are a leaf
+			if ($node instanceof LeafNode ||
+				! $node->hasChildren()
+			) {
+				continue;
+			}
+
+			$children = [];
+			$child    = $node->firstChild();
+			while ( ! is_null($child)) {
+				// wild card, grab all
+				if ($rule['tag'] == '*' && is_null($rule['key'])) {
+					$return[] = $child;
+					try {
+						$child = $node->nextChild($child->id());
+					} catch (ChildNotFoundException $e) {
+						// no more children
+						$child = null;
+					}
+					continue;
+				}
+
+				$pass = true;
+				// check tag
+				if ( ! empty($rule['tag']) && $rule['tag'] != $child->getTag()->name() &&
+					$rule['tag'] != '*'
+				) {
+					// child failed tag check
+					$pass = false;
+				}
+
+				// check key
+				if ($pass && ! is_null($rule['key'])) {
+					if ($rule['noKey']) {
+						if ( ! is_null($child->getAttribute($rule['key']))) {
+							$pass = false;
+						}
+					} else {
+						if ($rule['key'] != 'plaintext' &&
+							is_null($child->getAttribute($rule['key']))
+						) {
+							$pass = false;
+						}
+					}
+				}
+
+				// compare values
+				if ($pass && ! is_null($rule['key']) &&
+					! is_null($rule['value']) && $rule['value'] != '*'
+				) {
+					if ($rule['key'] == 'plaintext') {
+						// plaintext search
+						$nodeValue = $child->text();
+					} else {
+						// normal search
+						$nodeValue = $child->getAttribute($rule['key']);
+					}
+
+					$check = $this->match($rule['operator'], $rule['value'], $nodeValue);
+
+					// handle multiple classes
+					if ( ! $check && $rule['key'] == 'class') {
+						$childClasses = explode(' ', $child->getAttribute('class'));
+						foreach ($childClasses as $class) {
+							if ( ! empty($class)) {
+								$check = $this->match($rule['operator'], $rule['value'], $class);
+							}
+							if ($check) {
+								break;
+							}
+						}
+					}
+
+					if ( ! $check) {
+						$pass = false;
+					}
+				}
+
+				if ($pass) {
+					// it passed all checks
+					$return[] = $child;
+				} else {
+					// this child failed to be matched
+					if ($child instanceof InnerNode &&
+						$child->hasChildren()
+					) {
+						// we still want to check its children
+						$children[] = $child;
+					}
+				}
+
+				try {
+					// get next child
+					$child = $node->nextChild($child->id());
+				} catch (ChildNotFoundException $e) {
+					// no more children
+					$child = null;
+				}
+			}
+
+			if (( ! isset($options['checkGrandChildren']) ||
+					$options['checkGrandChildren'])
+				&& count($children) > 0
+			) {
+				// we have children that failed but are not leaves.
+				$matches = $this->seek($children, $rule, $options);
+				foreach ($matches as $match) {
+					$return[] = $match;
+				}
+			}
+		}
+
+		return $return;
+	}
+
+	/**
+	 * Attempts to match the given arguments with the given operator.
+	 *
+	 * @param string $operator
+	 * @param string $pattern
+	 * @param string $value
+	 * @return bool
+	 */
+	protected function match($operator, $pattern, $value)
+	{
+		$value   = strtolower($value);
+		$pattern = strtolower($pattern);
+		switch ($operator) {
+			case '=':
+				return $value === $pattern;
+			case '!=':
+				return $value !== $pattern;
+			case '^=':
+				return preg_match('/^'.preg_quote($pattern, '/').'/', $value);
+			case '$=':
+				return preg_match('/'.preg_quote($pattern, '/').'$/', $value);
+			case '*=':
+				if ($pattern[0] == '/') {
+					return preg_match($pattern, $value);
+				}
+
+				return preg_match("/".$pattern."/i", $value);
+		}
+
+		return false;
+	}
+
+	/**
+	 * Attempts to figure out what the alteration will be for
+	 * the next element.
+	 *
+	 * @param array $rule
+	 * @return array
+	 */
+	protected function alterNext($rule)
+	{
+		$options = [];
+		if ($rule['tag'] == '>') {
+			$options['checkGrandChildren'] = false;
+		}
+
+		return $options;
+	}
+
+	/**
+	 * Flattens the option array.
+	 *
+	 * @param array $optionsArray
+	 * @return array
+	 */
+	protected function flattenOptions(array $optionsArray)
+	{
+		$options = [];
+		foreach ($optionsArray as $optionArray) {
+			foreach ($optionArray as $key => $option) {
+				$options[$key] = $option;
+			}
+		}
+
+		return $options;
+	}
 }