Merge pull request #3 from mwijngaard/master

 Expand/fix a lot of type hints

Author: bpolaszek

src/IterableObject.php

@@ -11,7 +11,7 @@
 final class IterableObject implements IteratorAggregate
 {
     /**
-     * @var array|Traversable
+     * @var iterable|array|Traversable
      */
     private $iterable;
 
@@ -27,9 +27,9 @@ final class IterableObject implements IteratorAggregate
 
     /**
      * IterableObject constructor.
-     * @param               $iterable
-     * @param callable|null $filter
-     * @param callable|null $map
+     * @param iterable|array|Traversable $iterable
+     * @param callable|null              $filter
+     * @param callable|null              $map
      * @throws InvalidArgumentException
      */
     public function __construct($iterable, $filter = null, $map = null)

src/iterable-functions.php

@@ -13,7 +13,7 @@
     /**
      * Check wether or not a variable is iterable (i.e array or \Traversable)
      *
-     * @param  array|\Traversable $iterable
+     * @param  mixed $iterable
      * @return bool
      */
     function is_iterable($iterable)
@@ -27,8 +27,8 @@ function is_iterable($iterable)
     /**
      * Copy the iterable into an array. If the iterable is already an array, return it.
      *
-     * @param  iterable $iterable
-     * @param  bool $use_keys [optional] Whether to use the iterator element keys as index.
+     * @param  iterable|array|\Traversable $iterable
+     * @param  bool                        $use_keys [optional] Whether to use the iterator element keys as index.
      * @return array
      */
     function iterable_to_array($iterable, $use_keys = true)
@@ -42,7 +42,7 @@ function iterable_to_array($iterable, $use_keys = true)
     /**
      * If the iterable is not intance of \Traversable, it is an array => convert it to an ArrayIterator.
      *
-     * @param  $iterable
+     * @param  iterable|array|\Traversable $iterable
      * @return \Traversable
      */
     function iterable_to_traversable($iterable)
@@ -67,8 +67,8 @@ function iterable_to_traversable($iterable)
     /**
      * Filters an iterable.
      *
-     * @param          $iterable
-     * @param callable $filter
+     * @param iterable|array|\Traversable $iterable
+     * @param callable                    $filter
      * @return array|CallbackFilterIterator
      * @throws InvalidArgumentException
      */
@@ -106,9 +106,9 @@ function iterable_filter($iterable, $filter = null)
 }
 
 /**
- * @param               $iterable
- * @param callable|null $filter
- * @param callable|null $map
+ * @param iterable|array|\Traversable $iterable
+ * @param callable|null               $filter
+ * @param callable|null               $map
  * @return Traversable|IterableObject
  * @throws InvalidArgumentException
  */

src/iterable-map-php53.php

@@ -5,8 +5,8 @@
     /**
      * Maps a callable to an iterable.
      *
-     * @param          $iterable
-     * @param callable $map
+     * @param iterable|array|\Traversable $iterable
+     * @param callable                    $map
      * @return array|ArrayIterator
      * @throws InvalidArgumentException
      */

src/iterable-map-php55.php

@@ -5,8 +5,8 @@
     /**
      * Maps a callable to an iterable.
      *
-     * @param          $iterable
-     * @param callable $map
+     * @param iterable|array|\Traversable $iterable
+     * @param callable                    $map
      * @return array|Traversable
      * @throws InvalidArgumentException
      */