Doctrine\ODM\MongoDB\Iterator\CachingIterator

Complexity

Total Complexity

18

Size/Duplication

Total Lines	140
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

97.92%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	__destruct()	0	4	1
A	toArray()	0	6	1
A	current()	0	4	1
A	key()	0	4	1
A	next()	0	9	2
A	rewind()	0	11	2
A	valid()	0	4	1
A	exhaustIterator()	0	8	2
A	getIterator()	0	8	2
A	storeCurrentItem()	0	10	2
A	wrapTraversable()	0	9	2

<?php

declare(strict_types=1);

namespace Doctrine\ODM\MongoDB\Iterator;

use Generator;
use RuntimeException;
use Traversable;
use function current;
use function key;
use function next;
use function reset;

/**
 * Iterator for wrapping a Traversable and caching its results.
 *
 * By caching results, this iterators allows a Traversable to be counted and
 * rewound multiple times, even if the wrapped object does not natively support
 * those operations (e.g. MongoDB\Driver\Cursor).
 *
 * @internal
 */
final class CachingIterator implements Iterator
{
    /** @var array */
    private $items = [];

    /** @var Generator|null */
    private $iterator;

    /** @var bool */
    private $iteratorAdvanced = false;

    /** @var bool */
    private $iteratorExhausted = false;

    /**
     * Initialize the iterator and stores the first item in the cache. This
     * effectively rewinds the Traversable and the wrapping Generator, which
     * will execute up to its first yield statement. Additionally, this mimics
     * behavior of the SPL iterators and allows users to omit an explicit call
     * to rewind() before using the other methods.
     */
    public function __construct(Traversable $iterator)
    {
        $this->iterator = $this->wrapTraversable($iterator);
        $this->storeCurrentItem();
    }

    public function __destruct()
    {
        $this->iterator = null;
    }

    public function toArray() : array
    {
        $this->exhaustIterator();

        return $this->items;
    }

    /**
     * @see http://php.net/iterator.current
     *
     * @return mixed
     */
    public function current()
    {
        return current($this->items);
    }

    /**
     * @see http://php.net/iterator.mixed
     *
     * @return mixed
     */
    public function key()
    {
        return key($this->items);
    }

    /**
     * @see http://php.net/iterator.next
     */
    public function next() : void
    {
        if (! $this->iteratorExhausted) {
            $this->getIterator()->next();
            $this->storeCurrentItem();
        }

        next($this->items);
    }

    /**
     * @see http://php.net/iterator.rewind
     */
    public function rewind() : void
    {
        /* If the iterator has advanced, exhaust it now so that future iteration
         * can rely on the cache.
         */
        if ($this->iteratorAdvanced) {
            $this->exhaustIterator();
        }

        reset($this->items);
    }

    /**
     * @see http://php.net/iterator.valid
     */
    public function valid() : bool
    {
        return $this->key() !== null;
    }

    /**
     * Ensures that the inner iterator is fully consumed and cached.
     */
    private function exhaustIterator() : void
    {
        while (! $this->iteratorExhausted) {
            $this->next();
        }

        $this->iterator = null;
    }

    private function getIterator() : Generator
    {
        if ($this->iterator === null) {
            throw new RuntimeException('Iterator has already been destroyed');
        }

        return $this->iterator;
    }

    /**
     * Stores the current item in the cache.
     */
    private function storeCurrentItem() : void
    {
        $key = $this->getIterator()->key();

        if ($key === null) {
            return;
        }

        $this->items[$key] = $this->getIterator()->current();
    }

    private function wrapTraversable(Traversable $traversable) : Generator
    {
        foreach ($traversable as $key => $value) {
            yield $key => $value;
            $this->iteratorAdvanced = true;
        }

        $this->iteratorExhausted = true;
    }
}