loophp\iterators\SimpleCachingIteratorAggregate

Complexity

Total Complexity

3

Size/Duplication

Total Lines	29
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getIterator()	0	8	2
A	__construct()	0	5	1

<?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 CachingIterator;
use Iterator;
use IteratorAggregate;
use Traversable;

/**
 * @template TKey
 * @template T
 *
 * @implements IteratorAggregate<TKey, T>
 */
final class SimpleCachingIteratorAggregate implements IteratorAggregate
{
    /**
     * @var CachingIterator<TKey, T>
     */
    private CachingIterator $iterator;

    /**
     * @param Iterator<TKey, T> $iterator
     */
    public function __construct(Iterator $iterator)
    {
        $this->iterator = new CachingIterator(
            $iterator,
            CachingIterator::FULL_CACHE
        );
    }

    /**
     * @return Traversable<TKey, T>
     */
    public function getIterator(): Traversable
    {
        /** @var iterable<TKey, T> $traversable */
        $traversable = $this->iterator->getInnerIterator()->valid()
            ? $this->iterator
            : $this->iterator->getCache();

        yield from $traversable;
    }
}