Add a NodeInterface::clone() method.

loophp · Jun 14, 2019 · 6fd1ed1 · 6fd1ed1
1 parent f073959
commit 6fd1ed1
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 3 deletions.
diff --git a/spec/drupol/phptree/Node/ValueNodeSpec.php b/spec/drupol/phptree/Node/ValueNodeSpec.php
@@ -4,10 +4,30 @@
 
 namespace spec\drupol\phptree\Node;
 
+use drupol\phptree\Exporter\Text;
 use drupol\phptree\Node\ValueNode;
 
 class ValueNodeSpec extends NodeObjectBehavior
 {
+    public function it_can_be_cloned()
+    {
+        $this->beConstructedWith(2);
+
+        $node1 = new ValueNode(\mt_rand());
+        $node2 = new ValueNode(\mt_rand());
+        $node3 = new ValueNode(\mt_rand());
+        $node4 = new ValueNode(\mt_rand());
+
+        $this
+            ->add($node1->add($node2), $node3->add($node4));
+
+        $exporter = new Text();
+
+        $export = $exporter->export($this->getWrappedObject()->clone());
+
+        $this->shouldHaveSameTextExport($export);
+    }
+
     public function it_can_be_manipulated_like_an_array()
     {
         $this

diff --git a/src/Node/Node.php b/src/Node/Node.php
@@ -66,6 +66,29 @@ public function children(): \Traversable
         yield from $this->storage()->getChildren();
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function clone(): NodeInterface
+    {
+        // @todo: Replace with something better.
+        return \unserialize(\serialize($this));
+        // @todo: Unable to get this code working yet.
+        /*
+        $root = $this;
+
+        $root = clone $root;
+
+        $children = [];
+
+        foreach ($root->children() as $key => $child) {
+            $children[] = $child->clone();
+        }
+
+        return $root->withChildren(...$children);
+        */
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -273,11 +296,13 @@ public function setParent(?NodeInterface $node): NodeInterface
     /**
      * {@inheritdoc}
      */
-    public function withChildren(NodeInterface ...$nodes): NodeInterface
+    public function withChildren(?NodeInterface ...$nodes): NodeInterface
     {
         $clone = clone $this;
         $clone->storage()->getChildren()->exchangeArray([]);
 
+        $nodes = \array_filter($nodes);
+
         return [] === $nodes ?
             $clone :
             $clone->add(...$nodes);

diff --git a/src/Node/NodeInterface.php b/src/Node/NodeInterface.php
@@ -36,6 +36,14 @@ public function all(): \Traversable;
      */
     public function children(): \Traversable;
 
+    /**
+     * Clone the tree and all of its children.
+     *
+     * @return \drupol\phptree\Node\NodeInterface
+     *   The tree.
+     */
+    public function clone(): NodeInterface;
+
     /**
      * The amount of children a node has.
      *
@@ -147,11 +155,11 @@ public function setParent(?NodeInterface $node): NodeInterface;
     /**
      * Get a clone of the object with or without children.
      *
-     * @param \drupol\phptree\Node\NodeInterface ...$nodes
+     * @param null|\drupol\phptree\Node\NodeInterface ...$nodes
      *   The children that the clone will have.
      *
      * @return \drupol\phptree\Node\NodeInterface
      *   The new object
      */
-    public function withChildren(NodeInterface ...$nodes): NodeInterface;
+    public function withChildren(?NodeInterface ...$nodes): NodeInterface;
 }