Merge pull request #6 from CrimsonNynja/PHP-7.4

upgraded to utilize PHP 7.4 features

Author: CrimsonNynja

composer.json

@@ -10,7 +10,7 @@
         }
     ],
     "require": {
-        "php": ">=7.2.0"
+        "php": ">=7.4.0"
     },
     "autoload": {
         "psr-4": {

composer.lock

@@ -11,11 +11,11 @@
 class BinarySearchTree implements \Iterator
 {
     /* the root of the tree */
-    private $root = null;
+    private ?BstNode $root = null;
     /* used for iterating over the tree */
-    private $iteratorPosition = false;
+    private ?BstNode $iteratorPosition = null;
     /* used for iterating through the tree */
-    private $iteratorStack = null;
+    private ?Stack $iteratorStack = null;
     /* if set, used to comparing non literal values */
     private $comparator = null;
 
@@ -92,9 +92,7 @@ public function getRoot() : ?BstNode
      */
     public function find($value, BstNode $node = null) : ?BstNode
     {
-        if ($node === null) {
-            $node = $this->root;
-        }
+        $node ??= $this->root;
 
         if ($this->root === null) {
             return null;
@@ -170,9 +168,7 @@ public function hasValues(...$values) : bool
      */
     private function getMinNode(BstNode $node = null) : ?BstNode
     {
-        if ($node === null) {
-            $node = $this->root;
-        }
+        $node ??= $this->root;
 
         if ($this->root === null) {
             return null;
@@ -293,7 +289,7 @@ public function hasComparator() : bool
     public function __clone()
     {
         $this->root = clone $this->root;
-        $this->iteratorPosition = false;
+        $this->iteratorPosition = null;
         $this->iteratorStack = null;
     }
 
@@ -332,12 +328,17 @@ public function next() : void
                     $node = $node->getLeftChild();
                 }
             }
-            $this->iteratorPosition = $this->iteratorStack->peek();
+            if ($this->iteratorStack->peek() !== false) {
+                $this->iteratorPosition = $this->iteratorStack->peek();
+            }
+            else {
+                $this->iteratorPosition = null;
+            }
         }
     }
 
     /**
-     * sets the iterator to the start value, or the left ;most leaf of the tree
+     * sets the iterator to the start value, or the left most leaf of the tree
      */
     public function rewind() : void
     {
@@ -358,7 +359,7 @@ public function rewind() : void
      */
     public function valid() : bool
     {
-        if ($this->iteratorPosition === false) {
+        if ($this->iteratorPosition === null) {
             return false;
         }
         return true;

src/PhpTrees/BinarySearchTree.php

@@ -10,13 +10,13 @@ class BstNode
     /* the nodes value */
     private $value = null;
     /* the left child of the node */
-    private $left = null;
+    private ?BstNode $left = null;
     /* the right child of the node */
-    private $right = null;
+    private ?BstNode $right = null;
     /* used for quick deletions */
-    private $parent = null;
+    private ?BstNode $parent = null;
     /* the node's id, used for iterating over the tree */
-    private $id = 0;
+    private int $id = 0;
     /* if set, used to comparing non literal values */
     private $comparator = null;
 

src/PhpTrees/BstNode.php

@@ -12,11 +12,11 @@ class GenericNode
     /* The value of the node */
     private $value = null;
     /* The nodes children */
-    private $children = [];
+    private array $children = [];
     /* the nodes parent */
-    private $parent = null;
+    private ?GenericNode $parent = null;
     /* the nodes id */
-    private $id = 0;
+    private int $id = 0;
 
     /**
      * constructs a node

src/PhpTrees/GenericNode.php

@@ -10,7 +10,7 @@
 class GenericTree
 {
     /* the root of the tree */
-    private $root;
+    private ?GenericNode $root = null;
 
     /**
      * construct the node
@@ -38,9 +38,8 @@ public function getRoot() : ?GenericNode
      */
     public function findNode(int $id, ?GenericNode $node = null) : ?GenericNode
     {
-        if ($node === null) {
-            $node = $this->root;
-        }
+        $node ??= $this->root;
+
         if ($node === null) {
             return null;
         }
@@ -68,9 +67,8 @@ public function findNode(int $id, ?GenericNode $node = null) : ?GenericNode
      */
     public function findNodeByValue($value, ?GenericNode $node = null) : ?GenericNode
     {
-        if ($node === null) {
-            $node = $this->root;
-        }
+        $node ??= $this->root;
+
         if ($node === null) {
             return null;
         }

src/PhpTrees/GenericTree.php

@@ -10,7 +10,7 @@
 class Rope implements \ArrayAccess
 {
     /* the root of the tree */
-    private $root = null;
+    private ?RopeNode $root = null;
 
     /**
      * constructs the rope with default value if given
@@ -52,9 +52,7 @@ public function length() : int
      */
     public function insert(string $value, ?int $index = null) : void
     {
-        if ($index === null) {
-            $index = $this->length();
-        }
+        $index ??= $this->length();
 
         if ($index >= $this->length()) {
             $r = concatRope($this, new Rope($value));
@@ -77,9 +75,8 @@ public function insert(string $value, ?int $index = null) : void
      */
     public function index(int $index, RopeNode $node = null) : ?string
     {
-        if ($node === null) {
-            $node = $this->root;
-        }
+        $node ??= $this->root;
+
         if ($node === null) {
             return null;
         }
@@ -104,9 +101,7 @@ public function index(int $index, RopeNode $node = null) : ?string
      */
     public function &splitNodeAtPosition(int $index, RopeNode $node = null) : ?RopeNode
     {
-        if ($node === null) {
-            $node = $this->root;
-        }
+        $node ??= $this->root;
 
         if ($node->getWeight() <= $index && $node->getRightChild() !== null) {
             return $this->splitNodeAtPosition($index - $node->getWeight(), $node->getRightChild());

src/PhpTrees/Rope.php

@@ -8,15 +8,15 @@
 class RopeNode
 {
     /* THe value of the node */
-    private $value = null;
+    private ?string $value = null;
     /* the left child of the node */
-    private $left = null;
+    private ?RopeNode $left = null;
     /* the right child of the node */
-    private $right = null;
+    private ?RopeNode $right = null;
     /* the nodes parent */
-    private $parent = null;
+    private ?RopeNode $parent = null;
     /* the weight of the node, representing the value length */
-    private $weight = 0;
+    private int $weight = 0;
 
     /**
      * constructs a Rope Node

src/PhpTrees/RopeNode.php

@@ -7,7 +7,7 @@
  */
 class Stack
 {
-    private $container = [];
+    private array $container = [];
 
     /**
      * pushes the given values onto the stack

src/PhpTrees/Stack.php

@@ -82,9 +82,8 @@ public function testHasChild()
     public function testAddComparator()
     {
         $n = new BstNode("12345");
-        $n->setComparator(function($val, $val2) {
-            return (strlen($val) <= strlen($val2));
-        });
+        $n->setComparator(fn($val, $val2) => strlen($val) <= strlen($val2));
+
         $n->addChild("1234");
         $n->addChild("12345678");
         $n->addChild("12");
@@ -102,9 +101,7 @@ public function testHasComparator()
         $n = new BstNode("12345");
         $this->assertFalse($n->hasComparator());
 
-        $n->setComparator(function($v, $v2){
-            return true;
-        });
+        $n->setComparator(fn($v, $v2) => true);
         $this->assertTrue($n->hasComparator());
     }
 }