Use a node key and prevent invalid state (#13)

* Use a node key and prevent invalid state
* Check for invalid args

Author: kimpepper

src/NestedSetInterface.php

@@ -12,50 +12,50 @@ interface NestedSetInterface {
    *
    * @param \PNX\NestedSet\Node $target
    *   The target node to insert below.
-   * @param \PNX\NestedSet\Node $node
-   *   The node to insert. Only id and revision ID are required.
+   * @param \PNX\NestedSet\NodeKey $nodeKey
+   *   The node to insert.
    *
    * @return \PNX\NestedSet\Node
    *   Returns a new node with position values set.
    */
-  public function addNodeBelow(Node $target, Node $node);
+  public function addNodeBelow(Node $target, NodeKey $nodeKey);
 
   /**
    * Inserts a node before the target node.
    *
    * @param \PNX\NestedSet\Node $target
    *   The target node to insert before.
-   * @param \PNX\NestedSet\Node $node
-   *   The node to insert. Only id and revision ID are required.
+   * @param \PNX\NestedSet\NodeKey $nodeKey
+   *   The node key to insert.
    *
    * @return \PNX\NestedSet\Node
    *   Returns a node with position values set.
    */
-  public function addNodeBefore(Node $target, Node $node);
+  public function addNodeBefore(Node $target, NodeKey $nodeKey);
 
   /**
    * Inserts a node after the target node.
    *
    * @param \PNX\NestedSet\Node $target
    *   The target node to insert after.
-   * @param \PNX\NestedSet\Node $node
-   *   The node to insert. Only id and revision ID are required.
+   * @param \PNX\NestedSet\NodeKey $nodeKey
+   *   The node key to insert.
    *
    * @return \PNX\NestedSet\Node
    *   Returns a node with position values set.
    */
-  public function addNodeAfter(Node $target, Node $node);
+  public function addNodeAfter(Node $target, NodeKey $nodeKey);
 
   /**
    * Inserts a root node.
    *
-   * @param \PNX\NestedSet\Node $node
-   *   The root node.
+   * @param \PNX\NestedSet\NodeKey $nodeKey
+   *   The node key to insert.
    *
    * @return \PNX\NestedSet\Node
    *   A new node with position values set.
    */
-  public function addRootNode(Node $node);
+  public function addRootNode(NodeKey $nodeKey);
 
   /**
    * Deletes a node and moves descendants up a level.
@@ -76,61 +76,59 @@ public function deleteSubTree(Node $node);
   /**
    * Finds all descendants of a node.
    *
-   * @param \PNX\NestedSet\Node $node
-   *   The node.
+   * @param \PNX\NestedSet\NodeKey $nodeKey
+   *   The node key to find descendants for.
    * @param int $depth
    *   (optional) A depth limit. Defaults to 0, no limit.
    *
    * @return array
-   *   The nested array of descendants.
+   *    The nested array of descendants.
    */
-  public function findDescendants(Node $node, $depth = 0);
+  public function findDescendants(NodeKey $nodeKey, $depth = 0);
 
   /**
    * Finds all immediate children of a node.
    *
-   * @param \PNX\NestedSet\Node $node
-   *   The node.
+   * @param \PNX\NestedSet\NodeKey $nodeKey
+   *   The node key to find children for.
    *
    * @return array
    *   The children.
    */
-  public function findChildren(Node $node);
+  public function findChildren(NodeKey $nodeKey);
 
   /**
    * Finds all ancestors of a node.
    *
-   * @param \PNX\NestedSet\Node $node
-   *   The node.
+   * @param \PNX\NestedSet\NodeKey $nodeKey
+   *   The node to find ancestors for.
    *
    * @return array
    *   The ancestors.
    */
-  public function findAncestors(Node $node);
+  public function findAncestors(NodeKey $nodeKey);
 
   /**
    * Finds the parent node.
    *
-   * @param \PNX\NestedSet\Node $node
-   *   The node.
+   * @param \PNX\NestedSet\NodeKey $nodeKey
+   *   The node key.
    *
-   * @return Node
+   * @return \PNX\NestedSet\Node
    *   The parent node.
    */
-  public function findParent(Node $node);
+  public function findParent(NodeKey $nodeKey);
 
   /**
    * Gets a node for the ID and Revision ID.
    *
-   * @param int|string $id
-   *   The ID.
-   * @param int|string $revision_id
-   *   The revision ID.
+   * @param NodeKey $nodeKey
+   *   The node key.
    *
    * @return \PNX\NestedSet\Node
-   *   The node.
+   *    The node.
    */
-  public function getNode($id, $revision_id);
+  public function getNode(NodeKey $nodeKey);
 
   /**
    * Moves a subtree to be a new root of the tree.
@@ -189,4 +187,15 @@ public function getNodeAtPosition($left);
    */
   public function getTree();
 
+  /**
+   * Finds the root node for this node.
+   *
+   * @param \PNX\NestedSet\NodeKey $nodeKey
+   *   The node key.
+   *
+   * @return \PNX\NestedSet\Node
+   *   The root node.
+   */
+  public function findRoot(NodeKey $nodeKey);
+
 }

src/Node.php

@@ -8,18 +8,11 @@
 class Node {
 
   /**
-   * The node ID.
+   * The node key.
    *
-   * @var string|int
+   * @var NodeKey
    */
-  protected $id;
-
-  /**
-   * The revision ID.
-   *
-   * @var string|int
-   */
-  protected $revisionId;
+  protected $nodeKey;
 
   /**
    * The left value.
@@ -45,22 +38,31 @@ class Node {
   /**
    * Node constructor.
    *
-   * @param int|string $id
-   *   The ID.
-   * @param int|string $revisionId
-   *   The revision ID.
+   * @param NodeKey $nodeKey
+   *   The node key.
    * @param int $left
    *   The left value.
    * @param int $right
    *   The right value.
    * @param int $depth
    *   The depth.
    */
-  public function __construct($id, $revisionId = 0, $left = 0, $right = 0, $depth = 0) {
-    $this->id = $id;
-    $this->revisionId = $revisionId;
+  public function __construct(NodeKey $nodeKey, $left, $right, $depth) {
+    if ($nodeKey == NULL) {
+      throw new \InvalidArgumentException("Node key cannot be NULL");
+    }
+    $this->nodeKey = $nodeKey;
+    if ($left < 1) {
+      throw new \InvalidArgumentException("Left value must be > 0");
+    }
     $this->left = $left;
+    if ($right < 1) {
+      throw new \InvalidArgumentException("Right value must be > 0");
+    }
     $this->right = $right;
+    if ($depth < 0) {
+      throw new \InvalidArgumentException("Depth value must be >= 0");
+    }
     $this->depth = $depth;
   }
 
@@ -71,7 +73,7 @@ public function __construct($id, $revisionId = 0, $left = 0, $right = 0, $depth
    *   The ID.
    */
   public function getId() {
-    return $this->id;
+    return $this->nodeKey->getId();
   }
 
   /**
@@ -81,7 +83,17 @@ public function getId() {
    *   The revision ID.
    */
   public function getRevisionId() {
-    return $this->revisionId;
+    return $this->nodeKey->getRevisionId();
+  }
+
+  /**
+   * Gets the node key.
+   *
+   * @return \PNX\NestedSet\NodeKey
+   *   The node key.
+   */
+  public function getNodeKey() {
+    return $this->nodeKey;
   }
 
   /**

src/NodeKey.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace PNX\NestedSet;
+
+/**
+ * Represents the unique key used for a node.
+ */
+class NodeKey {
+
+  /**
+   * The node ID.
+   *
+   * @var string|int
+   */
+  protected $id;
+
+  /**
+   * The revision ID.
+   *
+   * @var string|int
+   */
+  protected $revisionId;
+
+  /**
+   * NodeKey constructor.
+   *
+   * @param int|string $id
+   *   The node id.
+   * @param int|string $revisionId
+   *   The node revision id.
+   */
+  public function __construct($id, $revisionId) {
+    $this->id = $id;
+    $this->revisionId = $revisionId;
+  }
+
+  /**
+   * Gets the node id.
+   *
+   * @return int|string
+   *   The node id.
+   */
+  public function getId() {
+    return $this->id;
+  }
+
+  /**
+   * Gets the node revision id.
+   *
+   * @return int|string
+   *   The node revision id.
+   */
+  public function getRevisionId() {
+    return $this->revisionId;
+  }
+
+}