Added support for node cloning

TonyBogdanov · Jan 5, 2018 · 0bbc920 · 0bbc920
1 parent 2106258
commit 0bbc920
Show file tree

Hide file tree

Showing 28 changed files with 1,731 additions and 512 deletions.
diff --git a/classes/Dom.php b/classes/Dom.php
@@ -78,7 +78,7 @@ public function __construct($content = null)
                 break;
 
             case $content instanceof self:
-                $this->nodes = $content->get();
+                $this->nodes = $content->nodes;
                 break;
 
             case $content instanceof NodeInterface:
@@ -196,15 +196,15 @@ public function get(int $index = null)
     }
 
     /**
-     * Add all nodes from the collection constructed by the specified content to the current list of nodes.
+     * Add the specified content to the end of the collection.
      *
      * @param $content
      * @return Dom
      */
     public function add($content): Dom
     {
         /** @var NodeInterface $node */
-        foreach ((new static($content))->get() as $node) {
+        foreach ((new static($content))->nodes as $node) {
             if (!in_array($node, $this->nodes, true)) {
                 $this->nodes[] = $node;
             }
@@ -270,7 +270,7 @@ public function children(): Dom
         $dom = new Dom();
 
         /** @var NodeInterface $node */
-        foreach ($this->get() as $node) {
+        foreach ($this->nodes as $node) {
             if ($node instanceof Element) {
                 /** @var NodeInterface $child */
                 foreach ($node as $child) {
@@ -281,4 +281,48 @@ public function children(): Dom
 
         return $dom;
     }
+
+    /**
+     * Insert content, specified by the parameter, to the end of immediate child nodes of all Element nodes in the
+     * collection.
+     *
+     * @param $content
+     * @return Dom
+     */
+    public function append($content): Dom
+    {
+        /** @var NodeInterface $node */
+        foreach ($this->nodes as $node) {
+            if ($node instanceof Element) {
+                /** @var NodeInterface $child */
+                foreach ((new static($content))->nodes as $child) {
+                    $node->insertAfter(null === $child->parent() ? $child : clone $child);
+                }
+            }
+        }
+
+        return $this;
+    }
+
+    /**
+     * Insert content, specified by the parameter, to the beginning of immediate child nodes of all Element nodes in
+     * the collection.
+     *
+     * @param $content
+     * @return Dom
+     */
+    public function prepend($content): Dom
+    {
+        /** @var NodeInterface $node */
+        foreach ($this->nodes as $node) {
+            if ($node instanceof Element) {
+                /** @var NodeInterface $child */
+                foreach (array_reverse((new static($content))->nodes) as $child) {
+                    $node->insertBefore($child);
+                }
+            }
+        }
+
+        return $this;
+    }
 }
diff --git a/classes/Node/CData.php b/classes/Node/CData.php
@@ -38,6 +38,14 @@ public function __toString(): string
         return '<![CDATA[' . $this->content . ']]>';
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function __clone()
+    {
+        throw new \BadMethodCallException('Native cloning is not allowed, use clone() instead.');
+    }
+
     /**
      * @inheritDoc
      */
@@ -92,4 +100,12 @@ public function detach(): NodeInterface
 
         return $this;
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function clone(): NodeInterface
+    {
+        return new static($this->content);
+    }
 }
diff --git a/classes/Node/Comment.php b/classes/Node/Comment.php
@@ -38,6 +38,14 @@ public function __toString(): string
         return '<!--' . $this->content . '-->';
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function __clone()
+    {
+        throw new \BadMethodCallException('Native cloning is not allowed, use clone() instead.');
+    }
+
     /**
      * @inheritDoc
      */
@@ -92,4 +100,12 @@ public function detach(): NodeInterface
 
         return $this;
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function clone(): NodeInterface
+    {
+        return new static($this->content);
+    }
 }
diff --git a/classes/Node/DocType.php b/classes/Node/DocType.php
@@ -33,6 +33,14 @@ public function __toString(): string
         return '<!DOCTYPE ' . $this->content . '>';
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function __clone()
+    {
+        throw new \BadMethodCallException('Native cloning is not allowed, use clone() instead.');
+    }
+
     /**
      * @inheritDoc
      */
@@ -64,4 +72,12 @@ public function detach(): NodeInterface
             explode('::', __METHOD__)[1]
         ));
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function clone(): NodeInterface
+    {
+        return new static($this->content);
+    }
 }
diff --git a/classes/Node/Element.php b/classes/Node/Element.php
@@ -78,6 +78,14 @@ public function __toString(): string
         return $html;
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function __clone()
+    {
+        throw new \BadMethodCallException('Native cloning is not allowed, use clone() instead.');
+    }
+
     /**
      * Return TRUE if the specified name exists as attribute.
      * The attribute name is lowercased.
@@ -192,6 +200,36 @@ public function detach(): NodeInterface
         return $this;
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function clone(): NodeInterface
+    {
+        $clone = new static($this->tag);
+
+        /**
+         * Inherit attributes.
+         *
+         * @var string $name
+         * @var string $value
+         */
+        foreach ($this->attributes as $name => $value) {
+            $clone->setAttribute($name, $value);
+        }
+
+        /**
+         * Inherit cloned child nodes.
+         *
+         * @var int $index
+         * @var NodeInterface $child
+         */
+        foreach ($this->children as $index => $child) {
+            $clone->insertAfter($child->clone());
+        }
+
+        return $clone;
+    }
+
     /**
      * @inheritDoc
      */

diff --git a/classes/Node/NodeInterface.php b/classes/Node/NodeInterface.php
@@ -17,6 +17,14 @@ interface NodeInterface
      */
     public function __toString(): string;
 
+    /**
+     * Throw exception to signify native cloning is not allowed.
+     * One should use clone() instead.
+     *
+     * @throws \BadMethodCallException
+     */
+    public function __clone();
+
     /**
      * Return the parent node or null if such isn't set.
      *
@@ -45,4 +53,13 @@ public function attach(NodeInterface $parent): NodeInterface;
      * @return $this
      */
     public function detach(): NodeInterface;
+
+    /**
+     * Ensure child nodes are also cloned when applicable.
+     * Ensure old node is detached from parent.
+     * Ensure (new) cloned node is attached to parent node.
+     *
+     * @return NodeInterface
+     */
+    public function clone(): NodeInterface;
 }
diff --git a/classes/Node/Text.php b/classes/Node/Text.php
@@ -38,6 +38,14 @@ public function __toString(): string
         return htmlspecialchars($this->content);
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function __clone()
+    {
+        throw new \BadMethodCallException('Native cloning is not allowed, use clone() instead.');
+    }
+
     /**
      * @inheritDoc
      */
@@ -92,4 +100,12 @@ public function detach(): NodeInterface
 
         return $this;
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function clone(): NodeInterface
+    {
+        return new static($this->content);
+    }
 }
diff --git a/docs/class-SDom.Dom.html b/docs/class-SDom.Dom.html
@@ -332,7 +332,7 @@ <h2>Implementation of</h2>
             <code><a href="source-class-SDom.Dom.html#204-214">add</a>( <span> <span class="property-name">$content</span> </span> )</code>
 
             <div class="description">
-                Add all nodes from the collection constructed by the specified content to the current list of nodes.
+                Add the specified content to the end of the collection.
 
 
 
@@ -507,6 +507,72 @@ <h2>Implementation of</h2>
 
 
 
+            </div>
+        </div>
+    </td>
+</tr>
+
+
+
+<tr id="_append">
+
+    <td class="attributes col-md-1">
+        <code class="keyword">
+                 public 
+
+
+        </code>
+    </td>
+
+    <td class="name">
+        <div>
+            <a class="anchor pull-right" href="#_append">#</a>
+            <code><a href="source-class-SDom.Dom.html#292-305">append</a>( <span> <span class="property-name">$content</span> </span> )</code>
+
+            <div class="description">
+                Insert content, specified by the parameter, to the end of immediate child nodes of all Element nodes in the
+collection.
+
+
+
+
+
+
+
+
+            </div>
+        </div>
+    </td>
+</tr>
+
+
+
+<tr id="_prepend">
+
+    <td class="attributes col-md-1">
+        <code class="keyword">
+                 public 
+
+
+        </code>
+    </td>
+
+    <td class="name">
+        <div>
+            <a class="anchor pull-right" href="#_prepend">#</a>
+            <code><a href="source-class-SDom.Dom.html#314-327">prepend</a>( <span> <span class="property-name">$content</span> </span> )</code>
+
+            <div class="description">
+                Insert content, specified by the parameter, to the beginning of immediate child nodes of all Element nodes in
+the collection.
+
+
+
+
+
+
+
+
             </div>
         </div>
     </td>