Doctrine\ODM\MongoDB\Iterator\BaseIterator

Complexity

Total Complexity

14

Size/Duplication

Total Lines	124
Duplicated Lines	4.84 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	toArray()	0	16	2
A	current()	0	4	1
A	key()	0	4	1
A	next()	0	6	2
A	rewind()	0	12	2
A	valid()	0	4	1
A	storeCurrentItem()	0	10	2
A	wrapTraversable()	6	13	2

<?php

declare(strict_types=1);

namespace Doctrine\ODM\MongoDB\Iterator;

use Generator;
use Traversable;

/**
 * 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 BaseIterator implements Iterator
{
    private $key;
    
    private $current;

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

    /** @var bool */
    private $iteratorAdvanced = 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 toArray() : array
    {
        if ($this->iteratorAdvanced) {
            throw new \LogicException(sprintf(
                'Cannot call %s for iterator that already yielded results',
                __METHOD__
            ));
        }
        
        $wrapper = function () {
            yield $this->key => $this->current;
            yield from $this->iterator;
        };
        
        return iterator_to_array($wrapper());
    }

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

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

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

    /**
     * @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) {
            throw new \LogicException(sprintf(
                'Cannot call %s for iterator that already yielded results',
                __METHOD__
            ));
        }
    }

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

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

        if ($this->key === null) {
            return;
        }

        $this->current = $this->iterator->current();
    }

    private function wrapTraversable(Traversable $traversable) : Generator
    {
        foreach ($traversable as $key => $value) {

This code seems to be duplicated across your project.

            $this->key = $key;
            $this->current = $value;
            yield $key => $value;
            $this->iteratorAdvanced = true;
        }

        $this->iterator = null;
        $this->key = null;
        $this->current = null;
    }
}