zicht / itertools

src/Zicht/Itertools/itertools.php

Doc Comments +7 added lines, -23 removed lines

@@ -166,8 +166,6 @@ 
  * > chain('ABC', 'DEF')
  * A B C D E F
  *
- * @param array|string|\Iterator $iterable
- * @param array|string|\Iterator $iterable2
  * @return ChainIterator
  */
 function chain(/* $iterable, $iterable2, ... */)
@@ -192,8 +190,8 @@ 
  * > count(2.5, 0.5)
  * 2.5 3.0 3.5 4.0 ...
  *
- * @param int|float $start
- * @param int|float $step
+ * @param integer $start
+ * @param integer $step
  * @return CountIterator
  */
 function count($start = 0, $step = 1)
@@ -217,7 +215,7 @@ 
  * > cycle('ABCD')
  * A B C D A B C D A B C D ...
  *
- * @param array|string|\Iterator $iterable
+ * @param lib\Traits\CycleTrait $iterable
  * @return CycleIterator
  */
 function cycle($iterable)
@@ -299,7 +297,6 @@ 
  *
  * @param null|string|\Closure $strategy
  * @param array|string|\Iterator $iterable
- * @param array|string|\Iterator $iterable2
  * @return MapIterator
  */
 function map($strategy, $iterable /*, $iterable2, ... */)
@@ -455,8 +452,6 @@ 
  * Make an iterator that returns values from $iterable where the
  * $strategy determines that the values are not empty
  *
- * @param null|string|\Closure $strategy, Optional, when not specified !empty will be used
- * @param array|string|\Iterator $iterable
  * @return FilterIterator
  */
 function filter(/* [$strategy, ] $iterable */)
@@ -490,9 +485,6 @@ 
  * TODO: document!
  * TODO: unit tests!
  *
- * @param string|\Closure $strategy
- * @param \Closure $closure Optional, when not specified !empty will be used
- * @param array|string|\Iterator $iterable
  * @return FilterIterator
  *
  * @deprecated Use filter() instead, will be removed in version 3.0
@@ -538,8 +530,6 @@ 
  * > zip([1, 2, 3], ['a', 'b', 'c'])
  * [1, 'a'] [2, 'b'] [3, 'c']
  *
- * @param array|string|\Iterator $iterable
- * @param array|string|\Iterator $iterable2
  * @return ZipIterator
  */
 function zip(/* $iterable, $iterable2, ... */)
@@ -557,7 +547,7 @@ 
 /**
  * Returns an iterable with all the elements from $ITERABLE reversed
  *
- * @param array|string|\Iterator $iterable
+ * @param lib\Traits\ReversedTrait $iterable
  * @return ReversedIterator
  */
 function reversed($iterable)
@@ -578,8 +568,6 @@ 
  * > unique('id', [['id' => 1, 'value' => 'a'], ['id' => 1, 'value' => 'b']])
  * ['id' => 1, 'value' => 'a']  # one element in this list
  *
- * @param null|string|\Closure $strategy
- * @param array|string|\Iterator $iterable
  * @return UniqueIterator
  */
 function unique(/* [$strategy,] $iterable */)
@@ -634,8 +622,6 @@ 
  * > any([1, null, 3])
  * true
  *
- * @param null|string|\Closure $strategy
- * @param array|string|\Iterator $iterable
  * @return boolean
  */
 function any(/* [$strategy,] $iterable */)
@@ -678,8 +664,6 @@ 
  * > all([1, null, 3])
  * false
  *
- * @param null|string|\Closure $strategy
- * @param array|string|\Iterator $iterable
  * @return boolean
  */
 function all(/* [$strategy,] $iterable */)
@@ -713,7 +697,7 @@ 
 /**
  * TODO: document!
  *
- * @param array|string|\Iterator $iterable
+ * @param lib\Traits\SliceTrait $iterable
  * @param integer $start
  * @param null|integer $end
  * @return SliceIterator
@@ -734,7 +718,7 @@ 
  *
  * TODO: unit tests!
  *
- * @param array|string|\Iterator $iterable
+ * @param lib\Traits\FirstTrait $iterable
  * @param mixed $default
  * @return mixed
  */
@@ -752,7 +736,7 @@ 
  *
  * TODO: unit tests!
  *
- * @param array|string|\Iterator $iterable
+ * @param lib\Traits\LastTrait $iterable
  * @param mixed $default
  * @return mixed
  */

Spacing +6 added lines, -6 removed lines

@@ -173,7 +173,7 @@ 
 function chain(/* $iterable, $iterable2, ... */)
 {
     $iterables = array_map(
-        function ($iterable) {
+        function($iterable) {
             return conversions\mixedToIterator($iterable);
         },
         func_get_args()
@@ -305,7 +305,7 @@ 
 function map($strategy, $iterable /*, $iterable2, ... */)
 {
     $iterables = array_map(
-        function ($iterable) {
+        function($iterable) {
             return conversions\mixedToIterator($iterable);
         },
         array_slice(func_get_args(), 1)
@@ -478,7 +478,7 @@ 
     }
 
     $strategy = conversions\mixedToValueGetter($strategy);
-    $isValid = function ($value, $key) use ($strategy) {
+    $isValid = function($value, $key) use ($strategy) {
         $tempVarPhp54 = $strategy($value, $key);
         return !empty($tempVarPhp54);
     };
@@ -503,7 +503,7 @@ 
     switch (sizeof($args)) {
         case 2:
             $strategy = conversions\mixedToValueGetter($args[0]);
-            $closure = function ($value, $key) use ($strategy) {
+            $closure = function($value, $key) use ($strategy) {
                 $tempVarPhp54 = call_user_func($strategy, $value, $key);
                 return !empty($tempVarPhp54);
             };
@@ -513,7 +513,7 @@ 
         case 3:
             $strategy = conversions\mixedToValueGetter($args[0]);
             $userClosure = $args[1];
-            $closure = function ($value, $key) use ($strategy, $userClosure) {
+            $closure = function($value, $key) use ($strategy, $userClosure) {
                 return call_user_func($userClosure, call_user_func($strategy, $value, $key));
             };
             $iterable = conversions\mixedToIterator($args[2]);
@@ -545,7 +545,7 @@ 
 function zip(/* $iterable, $iterable2, ... */)
 {
     $iterables = array_map(
-        function ($iterable) {
+        function($iterable) {
             return conversions\mixedToIterator($iterable);
         },
         func_get_args()

src/Zicht/Itertools/lib/SliceIterator.php

Doc Comments +4 added lines

@@ -60,6 +60,10 @@
     private $start;
     private $end;
 
+    /**
+     * @param integer $start
+     * @param integer $end
+     */
     public function __construct(\Iterator $iterable, $start, $end = null)
     {
         if ($start < 0 || $end < 0) {

Spacing +1 added lines, -1 removed lines

@@ -67,7 +67,7 @@
         }
 
         $this->index = 0;
-        $this->start = $start < 0 ? $length + $start: $start;
+        $this->start = $start < 0 ? $length + $start : $start;
         $this->end = $end === null ? null : ($end < 0 ? $length + $end : $end);
         parent::__construct($iterable);
     }

src/Zicht/Itertools/lib/Traits/ChainTrait.php

Doc Comments -2 removed lines

@@ -26,8 +26,6 @@
      * > iter\iterable('ABC', 'DEF')->chain()
      * A B C D E F
      *
-     * @param array|string|\Iterator $iterable
-     * @param array|string|\Iterator $iterable2
      * @return iter\lib\ChainIterator
      */
     public function chain(/* $iterable, $iterable2, ... */)

src/Zicht/Itertools/lib/Traits/ReduceTrait.php

Doc Comments -1 removed lines

@@ -25,7 +25,6 @@
      * > iter\iterable([])->reduce('min', 1)
      * 1
      *
-     * @param array|string|\Iterator $iterable
      * @param string|\Closure $closure
      * @param mixed $initializer
      * @return mixed

src/Zicht/Itertools/lib/Traits/ZipTrait.php

Doc Comments -1 removed lines

@@ -22,7 +22,6 @@
      * > zip([1, 2, 3], ['a', 'b', 'c'])
      * [1, 'a'] [2, 'b'] [3, 'c']
      *
-     * @param array|string|\Iterator $iterable2
      * @return iter\lib\ZipIterator
      */
     public function zip(/* $iterable2, ... */)

src/Zicht/Itertools/reductions.php

Doc Comments +1 added lines

@@ -176,6 +176,7 @@
 
 /**
  * @deprecated please use the reduction functions directly, will be removed in version 3.0
+ * @param string $name
  */
 function getReduction($name /* [argument, [arguments, ...] */)
 {

Spacing +7 added lines, -7 removed lines

@@ -15,7 +15,7 @@ 
  */
 function add()
 {
-    return function ($a, $b) {
+    return function($a, $b) {
         if (!is_numeric($a)) {
             throw new \InvalidArgumentException('Argument $A must be numeric to perform addition');
         }
@@ -33,7 +33,7 @@ 
  */
 function sub()
 {
-    return function ($a, $b) {
+    return function($a, $b) {
         if (!is_numeric($a)) {
             throw new \InvalidArgumentException('Argument $A must be numeric to perform subtraction');
         }
@@ -51,7 +51,7 @@ 
  */
 function mul()
 {
-    return function ($a, $b) {
+    return function($a, $b) {
         if (!is_numeric($a)) {
             throw new \InvalidArgumentException('Argument $A must be numeric to perform multiplication');
         }
@@ -69,7 +69,7 @@ 
  */
 function min()
 {
-    return function ($a, $b) {
+    return function($a, $b) {
         if (!is_numeric($a)) {
             throw new \InvalidArgumentException('Argument $A must be numeric to determine minimum');
         }
@@ -87,7 +87,7 @@ 
  */
 function max()
 {
-    return function ($a, $b) {
+    return function($a, $b) {
         if (!is_numeric($a)) {
             throw new \InvalidArgumentException('Argument $A must be numeric to determine maximum');
         }
@@ -109,7 +109,7 @@ 
     if (!is_string($glue)) {
         throw new \InvalidArgumentException('Argument $GLUE must be a string to join');
     }
-    return function ($a, $b) use ($glue) {
+    return function($a, $b) use ($glue) {
         if (!is_string($a)) {
             throw new \InvalidArgumentException('Argument $A must be a string to join');
         }
@@ -131,7 +131,7 @@ 
  */
 function chain()
 {
-    return function ($chainIterator, $b) {
+    return function($chainIterator, $b) {
         if (!($chainIterator instanceof ChainIterator)) {
             throw new \InvalidArgumentException('Argument $A must be a ChainIterator.  Did your call "reduce" with "new ChainIterator()" as the initial parameter?');
         }

src/Zicht/Itertools/lib/SortedIterator.php

Spacing +3 added lines, -3 removed lines

@@ -57,13 +57,13 @@ 
     public function __construct(\Closure $func, \Iterator $iterable, $reverse = false)
     {
         if ($reverse) {
-            $cmp = function ($a, $b) use ($func) {
+            $cmp = function($a, $b) use ($func) {
                 $orderA = $a['order'];
                 $orderB = $b['order'];
                 return $orderA == $orderB ? 0 : ($orderA < $orderB ? 1 : -1);
             };
         } else {
-            $cmp = function ($a, $b) use ($func) {
+            $cmp = function($a, $b) use ($func) {
                 $orderA = $a['order'];
                 $orderB = $b['order'];
                 return $orderA == $orderB ? 0 : ($orderA < $orderB ? -1 : 1);
@@ -72,7 +72,7 @@ 
 
         $data = [];
         foreach ($iterable as $key => $value) {
-            $data []= array('key' => $key, 'value' => $value, 'order' => call_user_func($func, $value, $key));
+            $data [] = array('key' => $key, 'value' => $value, 'order' => call_user_func($func, $value, $key));
         }
 
         $this->mergesort($data, $cmp);

Braces +10 added lines, -6 removed lines

@@ -114,8 +114,9 @@ 
     protected function mergesort(array &$array, \Closure $cmp_function)
     {
         // Arrays of size < 2 require no action.
-        if (count($array) < 2)
-            return;
+        if (count($array) < 2) {
+                    return;
+        }
 
         // Split the array in half
         $halfway = count($array) / 2;
@@ -138,15 +139,18 @@ 
         while ($ptr1 < count($array1) && $ptr2 < count($array2)) {
             if (call_user_func($cmp_function, $array1[$ptr1], $array2[$ptr2]) < 1) {
                 $array[] = $array1[$ptr1++];
-            }
-            else {
+            } else {
                 $array[] = $array2[$ptr2++];
             }
         }
 
         // Merge the remainder
-        while ($ptr1 < count($array1)) $array[] = $array1[$ptr1++];
-        while ($ptr2 < count($array2)) $array[] = $array2[$ptr2++];
+        while ($ptr1 < count($array1)) {
+            $array[] = $array1[$ptr1++];
+        }
+        while ($ptr2 < count($array2)) {
+            $array[] = $array2[$ptr2++];
+        }
         return;
     }
 }

src/Zicht/Itertools/lib/MapIterator.php

Spacing +3 added lines, -3 removed lines

@@ -61,11 +61,11 @@ 
 
     public function __construct(\Closure $valueFunc /* [\Closure $keyFunc], \Iterator $iterable1, [\Iterator $iterable2, [...]] */)
     {
-        parent::__construct(\MultipleIterator::MIT_NEED_ALL| \MultipleIterator::MIT_KEYS_NUMERIC);
+        parent::__construct(\MultipleIterator::MIT_NEED_ALL|\MultipleIterator::MIT_KEYS_NUMERIC);
         $args = func_get_args();
         $argsContainsKeyFunc = $args[1] instanceof \Closure;
         $this->valueFunc = $args[0];
-        $this->keyFunc = $argsContainsKeyFunc ? $args[1] : function () { return $this->genericKeysToKey(func_get_args()); };
+        $this->keyFunc = $argsContainsKeyFunc ? $args[1] : function() { return $this->genericKeysToKey(func_get_args()); };
         foreach (array_slice($args, $argsContainsKeyFunc ? 2 : 1) as $iterable) {
             if (!$iterable instanceof \Iterator) {
                 throw new \InvalidArgumentException(sprintf('Argument %d must be an iterator'));
@@ -86,7 +86,7 @@ 
         foreach ($keys as $key) {
             if ($key !== $value) {
                 // the keys are different, we will make a new string identifying this entry
-                return join(':', array_map(function ($key) { return (string)$key; }, $keys));
+                return join(':', array_map(function($key) { return (string)$key; }, $keys));
             }
         }
 

src/Zicht/Itertools/lib/GroupbyIterator.php

Spacing +1 added lines, -1 removed lines

@@ -160,7 +160,7 @@
         $array = iterator_to_array($this);
         array_walk(
             $array,
-            function (&$value) {
+            function(&$value) {
                 /** @var GroupedIterator $value */
                 $value = $value->toArray();
             }