Jasny\Container\Loader\AbstractLoader

Complexity

Total Complexity

13

Size/Duplication

Total Lines	101
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	2	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	key()	0	3	2
A	getInnerIterator()	0	3	1
A	__construct()	0	4	1
A	current()	0	3	2
A	valid()	0	3	2
A	rewind()	0	6	1
A	next()	0	11	4

<?php declare(strict_types=1);

namespace Jasny\Container\Loader;

/**
 * Base class for loader using two iterators.
 */
abstract class AbstractLoader implements \OuterIterator
{
    /**
     * @var \Iterator
     */
    protected $items;

    /**
     * @var \ArrayIterator|null
     */
    protected $entries;


    /**
     * Class constructor.
     *
     * @param \Iterator $items
     */
    public function __construct(\Iterator $items)
    {
        $this->items = $items;
        $this->prepareNext();
    }

    /**
     * Prepare new entries
     *
     * @return void
     */
    abstract protected function prepareNext(): void;

    /**
     * Return the current element
     *
     * @return callable|null
     */
    public function current(): ?callable
    {
        return isset($this->entries) ? $this->entries->current() : null;
    }

    /**
     * Move forward to next element
     *
     * @return void
     */
    public function next(): void
    {
        if (!isset($this->entries)) {
            // Shouldn't happen if `prepareNext()` works correctly
            return; // @codeCoverageIgnore
        }

        $this->entries->next();

        while (!$this->entries->valid() && $this->items->valid()) {
            $this->prepareNext();
        }
    }

    /**
     * Return the key of the current element
     *
     * @return string|null
     */
    public function key(): ?string
    {
        return isset($this->entries) ? (string)$this->entries->key() : null;
    }

    /**
     * Checks if current position is valid
     *
     * @return bool
     */
    public function valid(): bool
    {
        return isset($this->entries) && $this->entries->valid();
    }

    /**
     * Rewind the iterator to the first element
     *
     * @return void
     */
    public function rewind(): void
    {
        $this->items->rewind();
        $this->entries = null;

        $this->prepareNext();
    }

    /**
     * Returns the inner iterator for the current entry.
     *
     * @return \Iterator
     */
    public function getInnerIterator(): \Iterator
    {
        return $this->items;
    }
}