Athari / YaLinqo

YaLinqo/EnumerableGeneration.php

Doc Comments +12 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 ()
@@ -84,7 +84,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)
@@ -111,7 +111,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)
@@ -129,7 +129,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
      */
@@ -146,7 +146,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)
@@ -158,7 +158,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)
@@ -174,7 +174,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)
@@ -196,7 +196,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)
@@ -213,7 +213,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)
@@ -242,7 +242,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)
@@ -261,7 +261,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
      */

YaLinqo/EnumerablePagination.php

Doc Comments +4 added lines, -4 removed lines

@@ -385,7 +385,7 @@ 
      * <p>If source contains fewer than count elements, an empty sequence is returned. If count is less than or equal to zero, all elements of source are yielded.
      * <p>The {@link take} and skip methods are functional complements. Given a sequence coll and an integer n, concatenating the results of coll->take(n) and coll->skip(n) yields the same sequence as coll.
      * @param int $count The number of elements to skip before returning the remaining elements.
-     * @return Enumerable A sequence that contains the elements that occur after the specified index in the input sequence.
+     * @return EnumerablePagination A sequence that contains the elements that occur after the specified index in the input sequence.
      * @package YaLinqo\Pagination
      */
     public function skip ($count)
@@ -408,7 +408,7 @@ 
      * <p>This method tests each element of source by using predicate and skips the element if the result is true. After the predicate function returns false for an element, that element and the remaining elements in source are yielded and there are no more invocations of predicate. If predicate returns true for all elements in the sequence, an empty sequence is returned.
      * <p>The {@link takeWhile} and skipWhile methods are functional complements. Given a sequence coll and a pure function p, concatenating the results of coll->takeWhile(p) and coll->skipWhile(p) yields the same sequence as coll.
      * @param callable $predicate {(v, k) ==> result} A function to test each element for a condition.
-     * @return Enumerable A sequence that contains the elements from the input sequence starting at the first element in the linear series that does not pass the test specified by predicate.
+     * @return EnumerablePagination A sequence that contains the elements from the input sequence starting at the first element in the linear series that does not pass the test specified by predicate.
      * @package YaLinqo\Pagination
      */
     public function skipWhile ($predicate)
@@ -432,7 +432,7 @@ 
      * <p>Take enumerates source and yields elements until count elements have been yielded or source contains no more elements. If count is less than or equal to zero, source is not enumerated and an empty sequence is returned.
      * <p>The take and {@link skip} methods are functional complements. Given a sequence coll and an integer n, concatenating the results of coll->take(n) and coll->skip(n) yields the same sequence as coll.
      * @param int $count The number of elements to return.
-     * @return Enumerable A sequence that contains the specified number of elements from the start of the input sequence.
+     * @return EnumerablePagination A sequence that contains the specified number of elements from the start of the input sequence.
      * @package YaLinqo\Pagination
      */
     public function take ($count)
@@ -457,7 +457,7 @@ 
      * <p>The takeWhile method tests each element of source by using predicate and yields the element if the result is true. Enumeration stops when the predicate function returns false for an element or when source contains no more elements.
      * <p>The takeWhile and {@link skipWhile} methods are functional complements. Given a sequence coll and a pure function p, concatenating the results of coll->takeWhile(p) and coll->skipWhile(p) yields the same sequence as coll.
      * @param callable $predicate {(v, k) ==> result} A function to test each element for a condition.
-     * @return Enumerable A sequence that contains the elements from the input sequence that occur before the element at which the test no longer passes.
+     * @return EnumerablePagination A sequence that contains the elements from the input sequence that occur before the element at which the test no longer passes.
      * @package YaLinqo\Pagination
      */
     public function takeWhile ($predicate)

YaLinqo/Functions.php

Doc Comments +1 added lines, -1 removed lines

@@ -142,7 +142,7 @@
 
     /**
      * Increment function: returns incremental integers starting from 0.
-     * @return callable
+     * @return \Closure
      */
     public static function increment ()
     {

YaLinqo/OrderedEnumerable.php

Doc Comments +7 added lines, -1 removed lines

@@ -67,7 +67,7 @@ 
      * <p>Three methods are defined to extend the type OrderedEnumerable, which is the return type of this method. These three methods, namely {@link thenBy}, {@link thenByDescending} and {@link thenByDir}, enable you to specify additional sort criteria to sort a sequence. These methods also return an OrderedEnumerable, which means any number of consecutive calls to thenBy, thenByDescending or thenByDir can be made.
      * <p>Because OrderedEnumerable inherits from {@link Enumerable}, you can call {@link Enumerable::orderBy orderBy}, {@link Enumerable::orderByDescending orderByDescending} or {@link Enumerable::orderByDir orderByDir} on the results of a call to orderBy, orderByDescending, orderByDir, thenBy, thenByDescending or thenByDir. Doing this introduces a new primary ordering that ignores the previously established ordering.
      * <p>This method performs an unstable sort; that is, if the keys of two elements are equal, the order of the elements is not preserved. In contrast, a stable sort preserves the order of elements that have the same key. Internally, {@link usort} is used.
-     * @param int|bool $sortOrder A direction in which to order the elements: false or SORT_DESC for ascending (by increasing value), true or SORT_ASC for descending (by decreasing value).
+     * @param boolean $sortOrder A direction in which to order the elements: false or SORT_DESC for ascending (by increasing value), true or SORT_ASC for descending (by decreasing value).
      * @param callable|null $keySelector {(v, k) ==> key} A function to extract a key from an element. Default: value.
      * @param callable|int|null $comparer {(a, b) ==> diff} Difference between a and b: &lt;0 if a&lt;b; 0 if a==b; &gt;0 if a&gt;b. Can also be a combination of SORT_ flags.
      * @return \YaLinqo\OrderedEnumerable
@@ -124,6 +124,9 @@ 
         return $this->sortByMultipleFields($array, $canMultisort);
     }
 
+    /**
+     * @param boolean $canMultisort
+     */
     private function trySortBySingleField ($array, $canMultisort)
     {
         if ($this->parent !== null || $array === null) {
@@ -151,6 +154,9 @@ 
         return new \ArrayIterator($array);
     }
 
+    /**
+     * @param boolean $canMultisort
+     */
     private function sortByMultipleFields ($array, $canMultisort)
     {
         $orders = [ ];

YaLinqo/Enumerable.php

Doc Comments +4 added lines, -4 removed lines

@@ -34,7 +34,7 @@ 
 
     /**
      * @internal
-     * @param \Closure|\Iterator $iterator
+     * @param \Closure $iterator
      * @param bool $isClosure
      */
     private function __construct ($iterator, $isClosure = true)
@@ -212,7 +212,7 @@ 
      * <p>Three methods are defined to extend the type {@link OrderedEnumerable}, which is the return type of this method. These three methods, namely {@link OrderedEnumerable::thenBy thenBy}, {@link OrderedEnumerable::thenByDescending thenByDescending} and {@link OrderedEnumerable::thenByDir thenByDir}, enable you to specify additional sort criteria to sort a sequence. These methods also return an OrderedEnumerable, which means any number of consecutive calls to thenBy, thenByDescending or thenByDir can be made.
      * <p>Because OrderedEnumerable inherits from Enumerable, you can call {@link orderBy}, {@link orderByDescending} or {@link orderByDir} on the results of a call to orderBy, orderByDescending, orderByDir, thenBy, thenByDescending or thenByDir. Doing this introduces a new primary ordering that ignores the previously established ordering.
      * <p>This method performs an unstable sort; that is, if the keys of two elements are equal, the order of the elements is not preserved. In contrast, a stable sort preserves the order of elements that have the same key. Internally, {@link usort} is used.
-     * @param int|bool $sortOrder A direction in which to order the elements: false or SORT_DESC for ascending (by increasing value), true or SORT_ASC for descending (by decreasing value).
+     * @param boolean $sortOrder A direction in which to order the elements: false or SORT_DESC for ascending (by increasing value), true or SORT_ASC for descending (by decreasing value).
      * @param callable|null $keySelector {(v, k) ==> key} A function to extract a key from an element. Default: value.
      * @param callable|int|null $comparer {(a, b) ==> diff} Difference between a and b: &lt;0 if a&lt;b; 0 if a==b; &gt;0 if a&gt;b. Can also be a combination of SORT_ flags.
      * @return OrderedEnumerable
@@ -850,7 +850,7 @@ 
 
     /**
      * Proc for {@link toArrayDeep}.
-     * @param $enum \Traversable Source sequence.
+     * @param Enumerable $enum \Traversable Source sequence.
      * @return array An array that contains the elements from the input sequence.
      * @package YaLinqo\Conversion
      */
@@ -900,7 +900,7 @@ 
 
     /**
      * Proc for {@link toListDeep}.
-     * @param $enum \Traversable Source sequence.
+     * @param Enumerable $enum \Traversable Source sequence.
      * @return array An array that contains the elements from the input sequence.
      * @package YaLinqo\Conversion
      */