IteratorTools::fromGenerator() - Code Metrics - K-Phoen/rulerz - Measure and Improve Code Quality continuously with Scrutinizer

IteratorTools::fromGenerator() A
last analyzed 2020-01-03 13:52 UTC

↳ Parent: IteratorTools

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace RulerZ\Result;

use ArrayIterator;

/**
 * Set of utility methods to create traversable objects from various inputs.
 */
class IteratorTools
{
    /**
     * Ensures that the given items are \Traversable.
     *
     * Usage:
     *
     * ```
     * IteratorTools::ensureTraversable([1, 2, 3]);
     * IteratorTools::ensureTraversable(new \ArrayIterator([1, 2, 3]));
     * ```
     *
     * @param mixed $items
     *
     * @throws \InvalidArgumentException
     */
    public static function ensureTraversable($items): \Traversable
    {
        if ($items instanceof \Traversable) {
            return $items;
        }

        if (is_array($items)) {
            return self::fromArray($items);
        }

        throw new \InvalidArgumentException('Un-handled argument of type: '.get_class($items));
    }

    /**
     * Creates an iterator from an array.
     *
     * Usage:
     *
     * ```
     * IteratorTools::fromArray([1, 2, 3]);
     * ```
     *
     * @param array $results
     */
    public static function fromArray(array $results): \Traversable
    {
        return new ArrayIterator($results);
    }

    /**
     * Creates an iterator from a generator.
     *
     * Example of valid usage:
     *
     * ```
     * IteratorTools::fromGenerator(function() {
     *     yield 1;
     *     yield 2;
     *     yield 3;
     * });
     * ```
     *
     * @param callable $generatorCallable A callable, which will return a generator once called.
     */
    public static function fromGenerator(callable $generatorCallable): \Traversable
    {
        return $generatorCallable();
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace RulerZ\Result;
6
7			use ArrayIterator;
8
9			/**
10			* Set of utility methods to create traversable objects from various inputs.
11			*/
12			class IteratorTools
13			{
14			/**
15			* Ensures that the given items are \Traversable.
16			*
17			* Usage:
18			*
19			* ```
20			* IteratorTools::ensureTraversable([1, 2, 3]);
21			* IteratorTools::ensureTraversable(new \ArrayIterator([1, 2, 3]));
22			* ```
23			*
24			* @param mixed $items
25			*
26			* @throws \InvalidArgumentException
27			*/
28			public static function ensureTraversable($items): \Traversable
29			{
30			if ($items instanceof \Traversable) {
31			return $items;
32			}
33
34			if (is_array($items)) {
35			return self::fromArray($items);
36			}
37
38			throw new \InvalidArgumentException('Un-handled argument of type: '.get_class($items));
39			}
40
41			/**
42			* Creates an iterator from an array.
43			*
44			* Usage:
45			*
46			* ```
47			* IteratorTools::fromArray([1, 2, 3]);
48			* ```
49			*
50			* @param array $results
51			*/
52			public static function fromArray(array $results): \Traversable
53			{
54			return new ArrayIterator($results);
55			}
56
57			/**
58			* Creates an iterator from a generator.
59			*
60			* Example of valid usage:
61			*
62			* ```
63			* IteratorTools::fromGenerator(function() {
64			* yield 1;
65			* yield 2;
66			* yield 3;
67			* });
68			* ```
69			*
70			* @param callable $generatorCallable A callable, which will return a generator once called.
71			*/
72			public static function fromGenerator(callable $generatorCallable): \Traversable
73			{
74			return $generatorCallable();
75			}
76			}
77

K-Phoen / rulerz

IteratorTools::fromGenerator() A last analyzed 2020-01-03 13:52 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

IteratorTools::fromGenerator() A
last analyzed 2020-01-03 13:52 UTC