Merge pull request #42 from nreynis/feature/strong-typing

Refactor to support strong typing.

src/AbstractChain.php

@@ -23,7 +23,7 @@ abstract class AbstractChain implements ArrayAccess, IteratorAggregate, JsonSeri
     /**
      * @return ArrayIterator
      */
-    public function getIterator()
+    public function getIterator(): ArrayIterator
     {
         return new ArrayIterator($this->array);
     }
@@ -33,7 +33,7 @@ public function getIterator()
      *
      * @return bool
      */
-    public function offsetExists($offset)
+    public function offsetExists($offset): bool
     {
         return isset($this->array[$offset]);
     }
@@ -52,23 +52,23 @@ public function offsetGet($offset)
      * @param mixed $offset
      * @param mixed $value
      */
-    public function offsetSet($offset, $value)
+    public function offsetSet($offset, $value): void
     {
         $this->array[$offset] = $value;
     }
 
     /**
      * @param mixed $offset
      */
-    public function offsetUnset($offset)
+    public function offsetUnset($offset): void
     {
         unset($this->array[$offset]);
     }
 
     /**
      * @return array
      */
-    public function jsonSerialize()
+    public function jsonSerialize(): array
     {
         return $this->array;
     }

src/Chain.php

@@ -104,7 +104,7 @@ public function __construct(array $array = [])
      *
      * @return Chain
      */
-    public static function create(array $array = [])
+    public static function create(array $array = []): Chain
     {
         return new static($array);
     }
@@ -117,7 +117,7 @@ public static function create(array $array = [])
      *
      * @return Chain
      */
-    public static function createFromString($delimiter, $string, array $options = [])
+    public static function createFromString(string $delimiter, string $string, array $options = []): Chain
     {
         $options = array_merge(['regexp' => false], $options);
         $chain   = new static();

src/Link/ChangeKeyCase.php

@@ -20,7 +20,7 @@ trait ChangeKeyCase
      *
      * @return Chain
      */
-    public function changeKeyCase($case = CASE_LOWER)
+    public function changeKeyCase(int $case = CASE_LOWER): Chain
     {
         $this->array = array_change_key_case($this->array, $case);
 

src/Link/Combine.php

@@ -20,7 +20,7 @@ trait Combine
      *
      * @return Chain
      */
-    public function combine($keys, $values)
+    public function combine($keys, $values): Chain
     {
         $this->array = array_combine(
             $keys instanceof Chain ? $keys->array : $keys,

src/Link/Count.php

@@ -15,7 +15,7 @@ trait Count
      *
      * @return int Returns the number of elements in the array.
      */
-    public function count()
+    public function count(): int
     {
         return count($this->array);
     }

src/Link/CountValues.php

@@ -17,7 +17,7 @@ trait CountValues
      *
      * @return array An associative array of values from the array as keys and their count value.
      */
-    public function countValues()
+    public function countValues(): array
     {
         return array_count_values($this->array);
     }

src/Link/Diff.php

@@ -22,7 +22,7 @@ trait Diff
      *
      * @return Chain
      */
-    public function diff($array2)
+    public function diff($array2): Chain
     {
         $this->array = array_diff(
             $this->array,

src/Link/Fill.php

@@ -25,7 +25,7 @@ trait Fill
      *
      * @return Chain
      */
-    public static function fill($startIndex, $num, $value = null)
+    public static function fill(int $startIndex, int $num, $value = null): Chain
     {
         return new self(array_fill($startIndex, $num, $value));
     }

src/Link/Filter.php

@@ -22,7 +22,7 @@ trait Filter
      *
      * @return Chain
      */
-    public function filter(callable $callback)
+    public function filter(callable $callback): Chain
     {
         $this->array = array_filter($this->array, $callback, ARRAY_FILTER_USE_BOTH);
 

src/Link/FlatMap.php

@@ -12,9 +12,11 @@
 trait FlatMap
 {
     /**
+     * @param callable $callback
+     *
      * @return Chain
      */
-    public function flatMap(callable $callback)
+    public function flatMap(callable $callback): Chain
     {
         $flattened = [];
         foreach ($this->array as $index => $element) {

src/Link/Flip.php

@@ -2,6 +2,8 @@
 
 namespace Cocur\Chain\Link;
 
+use Cocur\Chain\Chain;
+
 /**
  * Flip.
  *
@@ -13,7 +15,7 @@ trait Flip
     /**
      * @return Chain
      */
-    public function flip()
+    public function flip(): Chain
     {
         $this->array = array_flip($this->array);
 

src/Link/Intersect.php

@@ -17,7 +17,7 @@ trait Intersect
      *
      * @return Chain
      */
-    public function intersect($array2)
+    public function intersect($array2): Chain
     {
         $this->array = array_intersect($this->array, $array2 instanceof Chain ? $array2->array : $array2);
 

src/Link/IntersectAssoc.php

@@ -17,7 +17,7 @@ trait IntersectAssoc
      *
      * @return Chain
      */
-    public function intersectAssoc($array)
+    public function intersectAssoc($array): Chain
     {
         $this->array = array_intersect_assoc($this->array, $array instanceof Chain ? $array->array : $array);
 

src/Link/IntersectKey.php

@@ -17,7 +17,7 @@ trait IntersectKey
      *
      * @return Chain
      */
-    public function intersectKey($array)
+    public function intersectKey($array): Chain
     {
         $this->array = array_intersect_key($this->array, $array instanceof Chain ? $array->array : $array);
 

src/Link/Join.php

@@ -18,7 +18,7 @@ trait Join
      * @return string Returns a string containing a string representation of all the array elements in the same order,
      *                with the glue string between each element.
      */
-    public function join($glue = '')
+    public function join(string $glue = ''): string
     {
         return implode($glue, $this->array);
     }

src/Link/KeyExists.php

@@ -20,7 +20,7 @@ trait KeyExists
      *
      * @return bool `true` if key or index exists in array, `false` otherwise.
      */
-    public function keyExists($key)
+    public function keyExists($key): bool
     {
         return array_key_exists($key, $this->array);
     }

src/Link/Keys.php

@@ -15,7 +15,7 @@ trait Keys
     /**
      * @return Chain
      */
-    public function keys()
+    public function keys(): Chain
     {
         $this->array = array_keys($this->array);
 

src/Link/Map.php

@@ -17,7 +17,7 @@ trait Map
      *
      * @return Chain
      */
-    public function map(callable $callback)
+    public function map(callable $callback): Chain
     {
         foreach ($this->array as $index => $element) {
             $this->array[$index] = $callback($element, $index);

src/Link/Merge.php

@@ -22,7 +22,7 @@ trait Merge
      *
      * @return Chain
      */
-    public function merge($array, array $options = [])
+    public function merge($array, array $options = []): Chain
     {
         $options = array_merge(['recursive' => false], $options);
 

src/Link/Pad.php

@@ -2,6 +2,8 @@
 
 namespace Cocur\Chain\Link;
 
+use Cocur\Chain\Chain;
+
 /**
  * Pad.
  *
@@ -16,7 +18,7 @@ trait Pad
      *
      * @return Chain
      */
-    public function pad($size, $value)
+    public function pad(int $size, $value): Chain
     {
         $this->array = array_pad($this->array, $size, $value);
 

src/Link/Product.php

@@ -11,7 +11,7 @@
 trait Product
 {
     /**
-     * @return number
+     * @return int|float
      */
     public function product()
     {

src/Link/Push.php

@@ -2,6 +2,8 @@
 
 namespace Cocur\Chain\Link;
 
+use Cocur\Chain\Chain;
+
 /**
  * Push.
  *
@@ -15,7 +17,7 @@ trait Push
      *
      * @return Chain
      */
-    public function push($element)
+    public function push($element): Chain
     {
         array_push($this->array, $element);
 

src/Link/Rand.php

@@ -15,7 +15,7 @@ trait Rand
      *
      * @return mixed
      */
-    public function rand($num = 1)
+    public function rand(int $num = 1)
     {
         return array_rand($this->array, $num);
     }

src/Link/Replace.php

@@ -17,7 +17,7 @@ trait Replace
      *
      * @return Chain
      */
-    public function replace($array)
+    public function replace($array): Chain
     {
         $this->array = array_replace($this->array, $array instanceof Chain ? $chain->array : $array);
 

src/Link/Reverse.php

@@ -17,7 +17,7 @@ trait Reverse
      *
      * @return Chain
      */
-    public function reverse($preserveKeys = false)
+    public function reverse(bool $preserveKeys = false): Chain
     {
         $this->array = array_reverse($this->array, $preserveKeys);
 

src/Link/Search.php

@@ -16,7 +16,7 @@ trait Search
      *
      * @return mixed
      */
-    public function search($needle, $strict = false)
+    public function search($needle, bool $strict = false)
     {
         return array_search($needle, $this->array, $strict);
     }

src/Link/Shuffle.php

@@ -2,6 +2,8 @@
 
 namespace Cocur\Chain\Link;
 
+use Cocur\Chain\Chain;
+
 /**
  * Shuffle.
  *
@@ -13,7 +15,7 @@ trait Shuffle
     /**
      * @return Chain
      */
-    public function shuffle()
+    public function shuffle(): Chain
     {
         shuffle($this->array);
 

src/Link/Slice.php

@@ -2,6 +2,8 @@
 
 namespace Cocur\Chain\Link;
 
+use Cocur\Chain\Chain;
+
 /**
  * Slice.
  *
@@ -17,7 +19,7 @@ trait Slice
      *
      * @return Chain
      */
-    public function slice($offset, $length = null, $preserveKeys = false)
+    public function slice(int $offset, ?int $length = null, bool $preserveKeys = false): Chain
     {
         $this->array = array_slice($this->array, $offset, $length, $preserveKeys);
 

src/Link/Sort.php

@@ -20,7 +20,7 @@ trait Sort
      *
      * @return Chain
      */
-    public function sort($sortBy = SORT_REGULAR, array $options = [])
+    public function sort($sortBy = SORT_REGULAR, array $options = []): Chain
     {
         if (!$sortBy) {
             $sortBy = SORT_REGULAR;
@@ -38,7 +38,7 @@ public function sort($sortBy = SORT_REGULAR, array $options = [])
      * @param callable $callback
      * @param array    $options
      */
-    private function sortWithCallback(callable $callback, array $options = [])
+    private function sortWithCallback(callable $callback, array $options = []): void
     {
         if (isset($options['assoc']) && $options['assoc']) {
             uasort($this->array, $callback);
@@ -51,7 +51,7 @@ private function sortWithCallback(callable $callback, array $options = [])
      * @param int   $sortFlags
      * @param array $options
      */
-    private function sortWithFlags($sortFlags = SORT_REGULAR, array $options = [])
+    private function sortWithFlags(int $sortFlags = SORT_REGULAR, array $options = []): void
     {
         if (!empty($options['assoc']) && !empty($options['reverse'])) {
             arsort($this->array, $sortFlags);

src/Link/SortKeys.php

@@ -20,7 +20,7 @@ trait SortKeys
      *
      * @return Chain
      */
-    public function sortKeys($sortBy = SORT_REGULAR, array $options = [])
+    public function sortKeys($sortBy = SORT_REGULAR, array $options = []): Chain
     {
         if ($sortBy && is_callable($sortBy)) {
             uksort($this->array, $sortBy);
@@ -35,7 +35,7 @@ public function sortKeys($sortBy = SORT_REGULAR, array $options = [])
      * @param int   $sortFlags
      * @param array $options
      */
-    private function sortKeysWithFlags($sortFlags = SORT_REGULAR, array $options = [])
+    private function sortKeysWithFlags(int $sortFlags = SORT_REGULAR, array $options = []): void
     {
         if (!empty($options['reverse'])) {
             krsort($this->array, $sortFlags);