loophp\iterators\MultipleIterableAggregate

Complexity

Total Complexity

3

Size/Duplication

Total Lines	36
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getIterator()	0	11	2

<?php

/**
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

declare(strict_types=1);

namespace loophp\iterators;

use Generator;
use IteratorAggregate;
use MultipleIterator;
use Traversable;

/**
 * @template TKey
 * @template T
 *
 * @implements IteratorAggregate<int, array<TKey, T>>
 */
final class MultipleIterableAggregate implements IteratorAggregate
{
    /**
     * @var (0|1|2|3)

The doc comment (0|1|2|3) at position 1 could not be parsed: Unknown type name '0' at position 1 in (0|1|2|3).

     */
    private int $flags;

    /**
     * @var iterable<mixed, iterable<TKey, T>>
     */
    private iterable $iterables;

    /**
     * @param iterable<mixed, iterable<TKey, T>> $iterables
     * @param (0|1|2|3) $flags

The doc comment (0|1|2|3) at position 1 could not be parsed: Unknown type name '0' at position 1 in (0|1|2|3).

     */
    public function __construct(iterable $iterables, int $flags = MultipleIterator::MIT_NEED_ALL | MultipleIterator::MIT_KEYS_NUMERIC)
    {
        $this->flags = $flags;
        $this->iterables = $iterables;
    }

    /**
     * @return Generator<int, array<TKey, T>>
     */
    public function getIterator(): Traversable
    {
        $mit = new MultipleIterator($this->flags);

        foreach ($this->iterables as $iterable) {
            $mit->attachIterator(
                (new IterableIteratorAggregate($iterable))->getIterator()
            );
        }

        yield from $mit;
    }
}