refactoring

Author: dan-on

examples/index.php

@@ -15,6 +15,7 @@
 
 // Get array of keys sorted in ascendant order
 $sorted_intervals = $tree->getKeys(); //  expected array [[1,1],[1,4],[5,7],[5,12],[6,8]]
+print_r($sorted_intervals);
 
 // Search items which keys intersect with given interval, and return array of values
 $valuesInRange = $tree->iterateIntersections([2,3]);
@@ -26,7 +27,6 @@
 echo $tree->hasIntersect([66,83]);
 echo $tree->countIntersections([2,3]);
 
-print_r($tree->getIntersections([2,3]));
 
 
 // $tree = new IntervalTree();

src/IntervalTree.php

@@ -17,9 +17,10 @@ public function __construct()
 
     /**
      * Returns number of items stored in the interval tree
-     * @returns {number}
+     *
+     * @return int
      */
-    public function getSize()
+    public function getSize(): int
     {
         $count = 0;
         $this->treeWalk($this->root, function () use (&$count) {
@@ -30,9 +31,10 @@ public function getSize()
 
     /**
      * Returns array of sorted keys in the ascending order
-     * @returns {Array}
+     *
+     * @return void
      */
-    public function getKeys()
+    public function getKeys(): array
     {
         $res = [];
 
@@ -73,7 +75,8 @@ public function getItems()
 
     /**
      * Returns true if tree is empty
-     * @returns {boolean}
+     *
+     * @return boolean
      */
     public function isEmpty()
     {
@@ -118,11 +121,12 @@ public function countIntersections($interval): int
 
     /**
      * Insert new item into interval tree
-     * @param key - interval object or array of two numbers [low, high]
-     * @param value - value representing any object (optional)
-     * @returns {Node} - returns reference to inserted node as an object {key:interval, value: value}
+     *
+     * @param array $key - array of two numbers [low, high]
+     * @param mixed $value - value representing any object (optional)
+     * @return Node - returns reference to inserted node
      */
-    public function insert($key, $value = null)
+    public function insert(array $key, mixed $value = null)
     {
         if ($key === null) {
             return;