php-ds / polyfill

src/Ds/PriorityQueue.php

Doc Comments +1 added lines, -1 removed lines

@@ -160,7 +160,7 @@
      * @param int $a
      * @param int $b
      *
-     * @return bool
+     * @return integer
      */
     private function compare(int $a, int $b)
     {

Indentation +1 added lines, -1 removed lines

@@ -282,7 +282,7 @@
      */
     private function siftUp(int $leaf)
     {
-         for (; $leaf > 0; $leaf = $parent) {
+            for (; $leaf > 0; $leaf = $parent) {
 
             $parent = $this->parent($leaf);
 

src/Ds/Traits/Sequence.php

Spacing +4 added lines, -4 removed lines

@@ -236,14 +236,14 @@ 
             return;
         }
 
-        $swap = function (&$a, &$b) {
+        $swap = function(&$a, &$b) {
             $t = $a;
             $a = $b;
             $b = $t;
         };
 
         // Reverses a range within the internal array
-        $reverse = function (int $a, int $b) use ($swap) {
+        $reverse = function(int $a, int $b) use ($swap) {
             while (--$b > $a) {
                 $swap($this->internal[$a++], $this->internal[$b--]);
             }
@@ -260,9 +260,9 @@ 
         }
 
         if ($r > 0) {
-            $reverse(0,  $r);
+            $reverse(0, $r);
             $reverse($r, $n);
-            $reverse(0,  $n);
+            $reverse(0, $n);
         }
     }
 

Unused Use Statements +2 added lines, -2 removed lines

@@ -1,10 +1,10 @@
 <?php
 namespace Ds\Traits;
 
+use Error;
 use OutOfRangeException;
-use UnderflowException;
 use Traversable;
-use Error;
+use UnderflowException;
 
 /**
  * Sequence

Upper-Lower-Casing +15 added lines, -15 removed lines

@@ -21,7 +21,7 @@ 
     /**
      * @inheritDoc
      */
-    public function __construct($values = null)
+    public function __construct($values = NULL)
     {
         if ($values) {
             if (is_integer($values)) {
@@ -65,22 +65,22 @@ 
     public function contains(...$values): bool
     {
         if ( ! $values) {
-            return false;
+            return FALSE;
         }
 
         foreach ($values as $value) {
-            if ($this->find($value) === false) {
-                return false;
+            if ($this->find($value) === FALSE) {
+                return FALSE;
             }
         }
 
-        return true;
+        return TRUE;
     }
 
     /**
      * @inheritDoc
      */
-    public function filter(callable $callback = null): \Ds\Sequence
+    public function filter(callable $callback = NULL): \Ds\Sequence
     {
         if ($callback) {
             return new self(array_filter($this->internal, $callback));
@@ -94,7 +94,7 @@ 
      */
     public function find($value)
     {
-        return array_search($value, $this->internal, true);
+        return array_search($value, $this->internal, TRUE);
     }
 
     /**
@@ -134,7 +134,7 @@ 
     /**
      * @inheritDoc
      */
-    public function join(string $glue = null): string
+    public function join(string $glue = NULL): string
     {
         return implode($glue, $this->internal);
     }
@@ -200,7 +200,7 @@ 
     /**
      * @inheritDoc
      */
-    public function reduce(callable $callback, $initial = null)
+    public function reduce(callable $callback, $initial = NULL)
     {
         return array_reduce($this->internal, $callback, $initial);
     }
@@ -212,7 +212,7 @@ 
     {
         $this->checkRange($index);
 
-        $value = array_splice($this->internal, $index, 1, null)[0];
+        $value = array_splice($this->internal, $index, 1, NULL)[0];
         $this->adjustCapacity();
 
         return $value;
@@ -293,7 +293,7 @@ 
     /**
      * @inheritDoc
      */
-    public function slice(int $offset, int $length = null): \Ds\Sequence
+    public function slice(int $offset, int $length = NULL): \Ds\Sequence
     {
         if (func_num_args() === 1) {
             return new self(array_slice($this->internal, $offset));
@@ -305,7 +305,7 @@ 
     /**
      * @inheritDoc
      */
-    public function sort(callable $comparator = null): \Ds\Sequence
+    public function sort(callable $comparator = NULL): \Ds\Sequence
     {
         $internal = $this->internal;
 
@@ -365,7 +365,7 @@ 
      */
     public function offsetSet($offset, $value)
     {
-        if ($offset === null) {
+        if ($offset === NULL) {
             $this->push($value);
         } else {
             $this->set($offset, $value);
@@ -398,9 +398,9 @@ 
     public function offsetExists($offset)
     {
         if ($offset < 0 || $offset >= count($this)) {
-            return false;
+            return FALSE;
         }
 
-        return $this->get($offset) !== null;
+        return $this->get($offset) !== NULL;
     }
 }

src/Ds/Map.php

Spacing +2 added lines, -2 removed lines

@@ -43,7 +43,7 @@ 
      */
     public function clear()
     {
-        $this->pairs  = [];
+        $this->pairs = [];
         $this->capacity = self::MIN_CAPACITY;
     }
 
@@ -209,7 +209,7 @@ 
      */
     private function identical($a, $b): bool
     {
-        if (is_object($a) && $a instanceof Hashable){
+        if (is_object($a) && $a instanceof Hashable) {
             return $a->equals($b);
         }
 

Braces +1 added lines, -1 removed lines

@@ -209,7 +209,7 @@
      */
     private function identical($a, $b): bool
     {
-        if (is_object($a) && $a instanceof Hashable){
+        if (is_object($a) && $a instanceof Hashable) {
             return $a->equals($b);
         }
 

Upper-Lower-Casing +17 added lines, -17 removed lines

@@ -27,7 +27,7 @@ 
      *
      * @param array|\Traversable $values
      */
-    public function __construct($values = null)
+    public function __construct($values = NULL)
     {
         if ($values) {
             if (is_integer($values)) {
@@ -231,7 +231,7 @@ 
             }
         }
 
-        $pair = null;
+        $pair = NULL;
 
         return $pair;
     }
@@ -247,16 +247,16 @@ 
     public function containsKey(...$keys): bool
     {
         if ( ! $keys) {
-            return false;
+            return FALSE;
         }
 
         foreach ($keys as $key) {
             if ( ! $this->lookup($key)) {
-                return false;
+                return FALSE;
             }
         }
 
-        return true;
+        return TRUE;
     }
 
     /**
@@ -270,7 +270,7 @@ 
     public function containsValue(...$values): bool
     {
         if ( ! $values) {
-            return false;
+            return FALSE;
         }
 
         foreach ($values as $value) {
@@ -280,10 +280,10 @@ 
                 }
             }
 
-            return false;
+            return FALSE;
         }
 
-        return true;
+        return TRUE;
     }
 
     /**
@@ -312,7 +312,7 @@ 
      *
      * @return Map
      */
-    public function filter(callable $callback = null): Map
+    public function filter(callable $callback = NULL): Map
     {
         $filtered = new self();
 
@@ -340,7 +340,7 @@ 
      * @throws OutOfBoundsException if no default was provided and the key is
      *                               not associated with a value.
      */
-    public function get($key, $default = null)
+    public function get($key, $default = NULL)
     {
         if (($pair = $this->lookup($key))) {
             return $pair->value;
@@ -449,7 +449,7 @@ 
      * @return mixed The carry value of the final iteration, or the initial
      *               value if the map was empty.
      */
-    public function reduce(callable $callback, $initial = null)
+    public function reduce(callable $callback, $initial = NULL)
     {
         $carry = $initial;
 
@@ -472,7 +472,7 @@ 
      * @throws \OutOfBoundsException if no default was provided and the key is
      *                               not associated with a value.
      */
-    public function remove($key, $default = null)
+    public function remove($key, $default = NULL)
     {
         foreach ($this->pairs as $position => $pair) {
 
@@ -482,7 +482,7 @@ 
                 // Delete pair, return its value
                 $value = $pair->value;
 
-                array_splice($this->pairs, $position, 1, null);
+                array_splice($this->pairs, $position, 1, NULL);
                 $this->adjustCapacity();
 
                 return $value;
@@ -532,7 +532,7 @@ 
      *
      * @return Map
      */
-    public function slice(int $offset, int $length = null): Map
+    public function slice(int $offset, int $length = NULL): Map
     {
         $map = new Map();
 
@@ -558,7 +558,7 @@ 
      *
      * @return Map
      */
-    public function sort(callable $comparator = null): Map
+    public function sort(callable $comparator = NULL): Map
     {
         $copy = $this->copy();
 
@@ -656,7 +656,7 @@ 
      */
     public function offsetUnset($offset)
     {
-        $this->remove($offset, null);
+        $this->remove($offset, NULL);
     }
 
     /**
@@ -664,6 +664,6 @@ 
      */
     public function offsetExists($offset)
     {
-        return $this->get($offset, null) !== null;
+        return $this->get($offset, NULL) !== NULL;
     }
 }

src/Ds/Collection.php

Doc Comments +1 added lines

@@ -10,6 +10,7 @@
 {
     /**
      * Clears all elements in the Collection.
+     * @return void
      */
     function clear();
 

src/Ds/Sequence.php

Doc Comments +8 added lines

@@ -13,6 +13,7 @@ 
      * object. The keys of either will not be preserved.
      *
      * @param array|\Traversable $values
+     * @return void
      */
     function __construct($values = null);
 
@@ -23,6 +24,7 @@ 
      * @param int $capacity The number of values for which capacity should be
      *                      allocated. Capacity will stay the same if this value
      *                      is less than or equal to the current capacity.
+     * @return void
      */
     function allocate(int $capacity);
 
@@ -94,6 +96,7 @@ 
      * @param mixed ...$values
      *
      * @throws \OutOfRangeException if the index is not in the range [0, n]
+     * @return void
      */
     function insert(int $index, ...$values);
 
@@ -148,6 +151,7 @@ 
      * Adds zero or more values to the end of the sequence.
      *
      * @param mixed ...$values
+     * @return void
      */
     function push(...$values);
 
@@ -155,6 +159,7 @@ 
      * Adds all values in an array or iterable object to the sequence.
      *
      * @param array|\Traversable $values
+     * @return void
      */
     function pushAll($values);
 
@@ -195,6 +200,7 @@ 
      * positive, or 'pop' and 'unshift' if negative.
      *
      * @param int $rotations The number of rotations (can be negative).
+     * @return void
      */
     function rotate(int $rotations);
 
@@ -205,6 +211,7 @@ 
      * @param mixed $value
      *
      * @throws \OutOfRangeException if the index is not in the range [0, size-1]
+     * @return void
      */
     function set(int $index, $value);
 
@@ -255,6 +262,7 @@ 
      * Adds zero or more values to the front of the sequence.
      *
      * @param mixed ...$values
+     * @return void
      */
     function unshift(...$values);
 }

Upper-Lower-Casing +6 added lines, -6 removed lines

@@ -14,7 +14,7 @@ 
      *
      * @param array|\Traversable $values
      */
-    function __construct($values = null);
+    function __construct($values = NULL);
 
     /**
      * Ensures that enough memory is allocated for a specified capacity. This
@@ -53,7 +53,7 @@ 
      *
      * @return Sequence
      */
-    function filter(callable $callback = null): Sequence;
+    function filter(callable $callback = NULL): Sequence;
 
     /**
      * Returns the index of a given value, or false if it could not be found.
@@ -105,7 +105,7 @@ 
      *
      * @return string
      */
-    function join(string $glue = null): string;
+    function join(string $glue = NULL): string;
 
     /**
      * Returns the last value in the sequence.
@@ -169,7 +169,7 @@ 
      * @return mixed The carry value of the final iteration, or the initial
      *               value if the sequence was empty.
      */
-    function reduce(callable $callback, $initial = null);
+    function reduce(callable $callback, $initial = NULL);
 
     /**
      * Removes and returns the value at a given index in the sequence.
@@ -238,7 +238,7 @@ 
      *
      * @return Sequence
      */
-    function slice(int $offset, int $length = null): Sequence;
+    function slice(int $offset, int $length = NULL): Sequence;
 
     /**
      * Returns a sorted copy of the sequence, based on an optional callable
@@ -249,7 +249,7 @@ 
      *
      * @return Sequence
      */
-    function sort(callable $comparator = null): Sequence;
+    function sort(callable $comparator = NULL): Sequence;
 
     /**
      * Adds zero or more values to the front of the sequence.

src/Ds/Queue.php

Upper-Lower-Casing +2 added lines, -2 removed lines

@@ -21,7 +21,7 @@ 
      *
      * @param array|\Traversable $values
      */
-    public function __construct($values = null)
+    public function __construct($values = NULL)
     {
         $this->internal = new Deque($values);
     }
@@ -141,7 +141,7 @@ 
      */
     public function offsetSet($offset, $value)
     {
-        if ($offset === null) {
+        if ($offset === NULL) {
             $this->push($value);
         } else {
             throw new Error();

src/Ds/Stack.php

Upper-Lower-Casing +3 added lines, -3 removed lines

@@ -23,7 +23,7 @@ 
      *
      * @param array|\Traversable $values
      */
-    public function __construct($values = null)
+    public function __construct($values = NULL)
     {
         $this->internal = new Vector($values);
     }
@@ -136,7 +136,7 @@ 
      */
     public function getIterator()
     {
-        while ($this->isEmpty() === false) {
+        while ($this->isEmpty() === FALSE) {
             yield $this->pop();
         }
     }
@@ -148,7 +148,7 @@ 
      */
     public function offsetSet($offset, $value)
     {
-        if ($offset === null) {
+        if ($offset === NULL) {
             $this->push($value);
         } else {
             throw new Error();

src/Ds/Set.php

Upper-Lower-Casing +13 added lines, -13 removed lines

@@ -27,7 +27,7 @@ 
      *
      * @param array|\Traversable $values
      */
-    public function __construct($values = null)
+    public function __construct($values = NULL)
     {
         $this->internal = new Map();
 
@@ -48,7 +48,7 @@ 
     public function add(...$values)
     {
         foreach ($values as $value) {
-            $this->internal[$value] = null;
+            $this->internal[$value] = NULL;
         }
     }
 
@@ -61,7 +61,7 @@ 
     {
         if ($values) {
             foreach ($values as $value) {
-                $this->internal[$value] = null;
+                $this->internal[$value] = NULL;
             }
         }
     }
@@ -108,16 +108,16 @@ 
     public function contains(...$values): bool
     {
         if ( ! $values) {
-            return false;
+            return FALSE;
         }
 
         foreach ($values as $value) {
             if ( ! $this->internal->containsKey($value)) {
-                return false;
+                return FALSE;
             }
         }
 
-        return true;
+        return TRUE;
     }
 
     /**
@@ -201,7 +201,7 @@ 
      *
      * @return Set
      */
-    public function filter(callable $callback = null): Set
+    public function filter(callable $callback = NULL): Set
     {
         $filtered = new Set();
 
@@ -290,7 +290,7 @@ 
      *
      * @return string
      */
-    public function join(string $glue = null): string
+    public function join(string $glue = NULL): string
     {
         return implode($glue, $this->toArray());
     }
@@ -316,7 +316,7 @@ 
      * @return mixed The carry value of the final iteration, or the initial
      *               value if the set was empty.
      */
-    public function reduce(callable $callback, $initial = null)
+    public function reduce(callable $callback, $initial = NULL)
     {
         $carry = $initial;
 
@@ -335,7 +335,7 @@ 
     public function remove(...$values)
     {
         foreach ($values as $value) {
-            $this->internal->remove($value, null);
+            $this->internal->remove($value, NULL);
         }
     }
 
@@ -373,7 +373,7 @@ 
      *
      * @return Set
      */
-    public function slice(int $offset, int $length = null): Set
+    public function slice(int $offset, int $length = NULL): Set
     {
         $sliced = new Set();
         $sliced->internal = $this->internal->slice($offset, $length);
@@ -390,7 +390,7 @@ 
      *
      * @return Set
      */
-    public function sort(callable $comparator = null): Set
+    public function sort(callable $comparator = NULL): Set
     {
         $set = new Set();
         $set->internal = $this->internal->sort($comparator);
@@ -448,7 +448,7 @@ 
      */
     public function offsetSet($offset, $value)
     {
-        if ($offset === null) {
+        if ($offset === NULL) {
             $this->add($value);
             return;
         }

src/Ds/Pair.php

Upper-Lower-Casing +3 added lines, -3 removed lines

@@ -24,7 +24,7 @@ 
      * @param mixed $key
      * @param mixed $value
      */
-    public function __construct($key = null, $value = null)
+    public function __construct($key = NULL, $value = NULL)
     {
         $this->key = $key;
         $this->value = $value;
@@ -40,12 +40,12 @@ 
     public function __get($name)
     {
         if ($name === 'key') {
-            $this->key = null;
+            $this->key = NULL;
             return $this->key;
         }
 
         if ($name === 'value') {
-            $this->value = null;
+            $this->value = NULL;
             return $this->value;
         }
     }