loophp / iterators

src/MultipleIterableAggregate.php

<?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;

/**
 * @template TKey
 * @template T
 *
 * @implements IteratorAggregate<array<int, TKey|null>, array<int, T|null>>
 */
final class MultipleIterableAggregate implements IteratorAggregate
{
    /**
     * @param iterable<array-key, 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(private iterable $iterables, private int $flags = MultipleIterator::MIT_NEED_ALL | MultipleIterator::MIT_KEYS_NUMERIC)
    {
    }

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

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

        yield from $mit;
    }
}