Athari / YaLinqo

YaLinqo/EnumerableGeneration.php

Doc Comments +15 added lines, -12 removed lines

@@ -13,7 +13,7 @@ 
      * @param array|\Iterator|\IteratorAggregate|Enumerable $source Source sequence.
      * @throws \InvalidArgumentException If source is not array or Traversible or Enumerable.
      * @throws \UnexpectedValueException If source contains no elements (checked during enumeration).
-     * @return Enumerable Endless list of items repeating the source sequence.
+     * @return EnumerableGeneration Endless list of items repeating the source sequence.
      * @package YaLinqo\Generation
      */
     public static function cycle ($source)
@@ -36,7 +36,7 @@ 
     /**
      * Returns an empty sequence.
      * <p><b>Syntax</b>: emptyEnum ()
-     * @return Enumerable
+     * @return EnumerableGeneration
      * @package YaLinqo\Generation
      */
     public static function emptyEnum ()
@@ -79,6 +79,9 @@ 
         throw new \InvalidArgumentException('source must be array or Traversable.');
     }
 
+    /**
+     * @param \Traversable $source
+     */
     private static function fromTraversable ($source)
     {
         foreach ($source as $k => $v)
@@ -93,7 +96,7 @@ 
      * @param mixed $seedValue Initial state of the generator loop for values. Default: null.
      * @param callable|null $funcKey {(v, k) ==> key} State update function to run on key after every iteration of the generator loop. Default: increment.
      * @param mixed $seedKey Initial state of the generator loop ofr keys. Default: 0.
-     * @return Enumerable
+     * @return EnumerableGeneration
      * @package YaLinqo\Generation
      */
     public static function generate ($funcValue, $seedValue = null, $funcKey = null, $seedKey = null)
@@ -120,7 +123,7 @@ 
      * <p><b>Syntax</b>: toInfinity ([start [, step]])
      * @param int $start The first integer in the sequence. Default: 0.
      * @param int $step The difference between adjacent integers. Default: 1.
-     * @return Enumerable
+     * @return EnumerableGeneration
      * @package YaLinqo\Generation
      */
     public static function toInfinity ($start = 0, $step = 1)
@@ -138,7 +141,7 @@ 
      * @param string $subject The input string.
      * @param string $pattern The pattern to search for, as a string.
      * @param int $flags Can be a combination of the following flags: PREG_PATTERN_ORDER, PREG_SET_ORDER, PREG_OFFSET_CAPTURE. Default: PREG_SET_ORDER.
-     * @return Enumerable
+     * @return EnumerableGeneration
      * @see preg_match_all
      * @package YaLinqo\Generation
      */
@@ -155,7 +158,7 @@ 
      * <p><b>Syntax</b>: toNegativeInfinity ([start [, step]])
      * @param int $start The first integer in the sequence. Default: 0.
      * @param int $step The difference between adjacent integers. Default: 1.
-     * @return Enumerable
+     * @return EnumerableGeneration
      * @package YaLinqo\Generation
      */
     public static function toNegativeInfinity ($start = 0, $step = 1)
@@ -167,7 +170,7 @@ 
      * Returns a sequence that contains a single element with a specified value.
      * <p><b>Syntax</b>: returnEnum (element)
      * @param mixed $element The single element in the resulting sequence.
-     * @return Enumerable Observable sequence containing the single specified element.
+     * @return EnumerableGeneration Observable sequence containing the single specified element.
      * @package YaLinqo\Generation
      */
     public static function returnEnum ($element)
@@ -183,7 +186,7 @@ 
      * @param int $start The value of the first integer in the sequence.
      * @param int $count The number of integers to generate.
      * @param int $step The difference between adjacent integers. Default: 1.
-     * @return Enumerable A sequence that contains a range of integral numbers.
+     * @return EnumerableGeneration A sequence that contains a range of integral numbers.
      * @package YaLinqo\Generation
      */
     public static function range ($start, $count, $step = 1)
@@ -205,7 +208,7 @@ 
      * @param int $start The value of the first integer in the sequence.
      * @param int $count The number of integers to generate.
      * @param int $step The difference between adjacent integers. Default: 1.
-     * @return Enumerable A sequence that contains a range of integral numbers.
+     * @return EnumerableGeneration A sequence that contains a range of integral numbers.
      * @package YaLinqo\Generation
      */
     public static function rangeDown ($start, $count, $step = 1)
@@ -222,7 +225,7 @@ 
      * @param int $end The value of the last integer in the sequence (not included).
      * @param int $step The difference between adjacent integers. Default: 1.
      * @throws \InvalidArgumentException If step is not a positive number.
-     * @return Enumerable A sequence that contains a range of integral numbers.
+     * @return EnumerableGeneration A sequence that contains a range of integral numbers.
      * @package YaLinqo\Generation
      */
     public static function rangeTo ($start, $end, $step = 1)
@@ -251,7 +254,7 @@ 
      * @param int $element The value to be repeated.
      * @param int $count The number of times to repeat the value in the generated sequence. Default: null.
      * @throws \InvalidArgumentException If count is less than 0.
-     * @return Enumerable A sequence that contains a repeated value.
+     * @return EnumerableGeneration A sequence that contains a repeated value.
      * @package YaLinqo\Generation
      */
     public static function repeat ($element, $count = null)
@@ -270,7 +273,7 @@ 
      * @param string $subject The input string.
      * @param string $pattern The pattern to search for, as a string.
      * @param int $flags flags can be any combination of the following flags: PREG_SPLIT_NO_EMPTY, PREG_SPLIT_DELIM_CAPTURE, PREG_SPLIT_OFFSET_CAPTURE. Default: 0.
-     * @return Enumerable
+     * @return EnumerableGeneration
      * @see preg_split
      * @package YaLinqo\Generation
      */

Spacing +21 added lines, -21 removed lines

@@ -16,11 +16,11 @@ 
      * @return Enumerable Endless list of items repeating the source sequence.
      * @package YaLinqo\Generation
      */
-    public static function cycle ($source)
+    public static function cycle($source)
     {
         $source = self::from($source);
 
-        return new self(function () use ($source) {
+        return new self(function() use ($source) {
             $isEmpty = true;
             while (true) {
                 foreach ($source as $v) {
@@ -39,7 +39,7 @@ 
      * @return Enumerable
      * @package YaLinqo\Generation
      */
-    public static function emptyEnum ()
+    public static function emptyEnum()
     {
         return new self(new \EmptyIterator, false);
     }
@@ -60,7 +60,7 @@ 
      * @return Enumerable
      * @package YaLinqo\Generation
      */
-    public static function from ($source)
+    public static function from($source)
     {
         $it = null;
         if ($source instanceof Enumerable)
@@ -79,7 +79,7 @@ 
         throw new \InvalidArgumentException('source must be array or Traversable.');
     }
 
-    private static function fromTraversable ($source)
+    private static function fromTraversable($source)
     {
         foreach ($source as $k => $v)
             yield $k => $v;
@@ -96,12 +96,12 @@ 
      * @return Enumerable
      * @package YaLinqo\Generation
      */
-    public static function generate ($funcValue, $seedValue = null, $funcKey = null, $seedKey = null)
+    public static function generate($funcValue, $seedValue = null, $funcKey = null, $seedKey = null)
     {
         $funcValue = Utils::createLambda($funcValue, 'v,k');
         $funcKey = Utils::createLambda($funcKey, 'v,k', false);
 
-        return new self(function () use ($funcValue, $funcKey, $seedValue, $seedKey) {
+        return new self(function() use ($funcValue, $funcKey, $seedValue, $seedKey) {
             $key = $seedKey === null ? ($funcKey ? $funcKey($seedValue, $seedKey) : 0) : $seedKey;
             $value = $seedValue === null ? $funcValue($seedValue, $seedKey) : $seedValue;
             yield $key => $value;
@@ -123,9 +123,9 @@ 
      * @return Enumerable
      * @package YaLinqo\Generation
      */
-    public static function toInfinity ($start = 0, $step = 1)
+    public static function toInfinity($start = 0, $step = 1)
     {
-        return new self(function () use ($start, $step) {
+        return new self(function() use ($start, $step) {
             $value = $start - $step;
             while (true)
                 yield $value += $step;
@@ -142,9 +142,9 @@ 
      * @see preg_match_all
      * @package YaLinqo\Generation
      */
-    public static function matches ($subject, $pattern, $flags = PREG_SET_ORDER)
+    public static function matches($subject, $pattern, $flags = PREG_SET_ORDER)
     {
-        return new self(function () use ($subject, $pattern, $flags) {
+        return new self(function() use ($subject, $pattern, $flags) {
             preg_match_all($pattern, $subject, $matches, $flags);
             return $matches !== false ? self::from($matches)->getIterator() : self::emptyEnum();
         });
@@ -158,7 +158,7 @@ 
      * @return Enumerable
      * @package YaLinqo\Generation
      */
-    public static function toNegativeInfinity ($start = 0, $step = 1)
+    public static function toNegativeInfinity($start = 0, $step = 1)
     {
         return self::toInfinity($start, -$step);
     }
@@ -170,7 +170,7 @@ 
      * @return Enumerable Observable sequence containing the single specified element.
      * @package YaLinqo\Generation
      */
-    public static function returnEnum ($element)
+    public static function returnEnum($element)
     {
         return self::repeat($element, 1);
     }
@@ -186,11 +186,11 @@ 
      * @return Enumerable A sequence that contains a range of integral numbers.
      * @package YaLinqo\Generation
      */
-    public static function range ($start, $count, $step = 1)
+    public static function range($start, $count, $step = 1)
     {
         if ($count <= 0)
             return self::emptyEnum();
-        return new self(function () use ($start, $count, $step) {
+        return new self(function() use ($start, $count, $step) {
             $value = $start - $step;
             while ($count-- > 0)
                 yield $value += $step;
@@ -208,7 +208,7 @@ 
      * @return Enumerable A sequence that contains a range of integral numbers.
      * @package YaLinqo\Generation
      */
-    public static function rangeDown ($start, $count, $step = 1)
+    public static function rangeDown($start, $count, $step = 1)
     {
         return self::range($start, $count, -$step);
     }
@@ -225,11 +225,11 @@ 
      * @return Enumerable A sequence that contains a range of integral numbers.
      * @package YaLinqo\Generation
      */
-    public static function rangeTo ($start, $end, $step = 1)
+    public static function rangeTo($start, $end, $step = 1)
     {
         if ($step <= 0)
             throw new \InvalidArgumentException(Errors::STEP_NEGATIVE);
-        return new self(function () use ($start, $end, $step) {
+        return new self(function() use ($start, $end, $step) {
             if ($start <= $end) {
                 for ($i = $start; $i < $end; $i += $step)
                     yield $i;
@@ -254,11 +254,11 @@ 
      * @return Enumerable A sequence that contains a repeated value.
      * @package YaLinqo\Generation
      */
-    public static function repeat ($element, $count = null)
+    public static function repeat($element, $count = null)
     {
         if ($count < 0)
             throw new \InvalidArgumentException(Errors::COUNT_LESS_THAN_ZERO);
-        return new self(function () use ($element, $count) {
+        return new self(function() use ($element, $count) {
             for ($i = 0; $i < $count || $count === null; $i++)
                 yield $element;
         });
@@ -274,7 +274,7 @@ 
      * @see preg_split
      * @package YaLinqo\Generation
      */
-    public static function split ($subject, $pattern, $flags = 0)
+    public static function split($subject, $pattern, $flags = 0)
     {
         return new self(
             new \ArrayIterator(preg_split($pattern, $subject, -1, $flags)),

Braces +42 added lines, -32 removed lines

@@ -27,8 +27,9 @@ 
                     yield $v;
                     $isEmpty = false;
                 }
-                if ($isEmpty)
-                    throw new \UnexpectedValueException(Errors::NO_ELEMENTS);
+                if ($isEmpty) {
+                                    throw new \UnexpectedValueException(Errors::NO_ELEMENTS);
+                }
             }
         });
     }
@@ -63,16 +64,17 @@ 
     public static function from ($source)
     {
         $it = null;
-        if ($source instanceof Enumerable)
-            return $source;
-        else if (is_array($source))
-            $it = new \ArrayIterator($source);
-        elseif ($source instanceof \Iterator)
-            $it = $source;
-        elseif ($source instanceof \IteratorAggregate)
-            $it = $source->getIterator();
-        elseif ($source instanceof \Traversable)
-            $it = self::fromTraversable($source);
+        if ($source instanceof Enumerable) {
+                    return $source;
+        } else if (is_array($source)) {
+                    $it = new \ArrayIterator($source);
+        } elseif ($source instanceof \Iterator) {
+                    $it = $source;
+        } elseif ($source instanceof \IteratorAggregate) {
+                    $it = $source->getIterator();
+        } elseif ($source instanceof \Traversable) {
+                    $it = self::fromTraversable($source);
+        }
         if ($it !== null) {
             return new self($it, false);
         }
@@ -81,8 +83,9 @@ 
 
     private static function fromTraversable ($source)
     {
-        foreach ($source as $k => $v)
-            yield $k => $v;
+        foreach ($source as $k => $v) {
+                    yield $k => $v;
+        }
     }
 
     /**
@@ -127,8 +130,9 @@ 
     {
         return new self(function () use ($start, $step) {
             $value = $start - $step;
-            while (true)
-                yield $value += $step;
+            while (true) {
+                            yield $value += $step;
+            }
         });
     }
 
@@ -188,12 +192,14 @@ 
      */
     public static function range ($start, $count, $step = 1)
     {
-        if ($count <= 0)
-            return self::emptyEnum();
+        if ($count <= 0) {
+                    return self::emptyEnum();
+        }
         return new self(function () use ($start, $count, $step) {
             $value = $start - $step;
-            while ($count-- > 0)
-                yield $value += $step;
+            while ($count-- > 0) {
+                            yield $value += $step;
+            }
         });
     }
 
@@ -227,16 +233,18 @@ 
      */
     public static function rangeTo ($start, $end, $step = 1)
     {
-        if ($step <= 0)
-            throw new \InvalidArgumentException(Errors::STEP_NEGATIVE);
+        if ($step <= 0) {
+                    throw new \InvalidArgumentException(Errors::STEP_NEGATIVE);
+        }
         return new self(function () use ($start, $end, $step) {
             if ($start <= $end) {
-                for ($i = $start; $i < $end; $i += $step)
-                    yield $i;
-            }
-            else {
-                for ($i = $start; $i > $end; $i -= $step)
-                    yield $i;
+                for ($i = $start; $i < $end; $i += $step) {
+                                    yield $i;
+                }
+            } else {
+                for ($i = $start; $i > $end; $i -= $step) {
+                                    yield $i;
+                }
             }
         });
     }
@@ -256,11 +264,13 @@ 
      */
     public static function repeat ($element, $count = null)
     {
-        if ($count < 0)
-            throw new \InvalidArgumentException(Errors::COUNT_LESS_THAN_ZERO);
+        if ($count < 0) {
+                    throw new \InvalidArgumentException(Errors::COUNT_LESS_THAN_ZERO);
+        }
         return new self(function () use ($element, $count) {
-            for ($i = 0; $i < $count || $count === null; $i++)
-                yield $element;
+            for ($i = 0; $i < $count || $count === null; $i++) {
+                            yield $element;
+            }
         });
     }