Arrayy\ArrayyRewindableGenerator

Complexity

Total Complexity

9

Size/Duplication

Total Lines	102
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

91.67%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	generateGenerator()	0	8	2
A	current()	0	4	1
A	next()	0	4	1
A	key()	0	4	1
A	valid()	0	4	1
A	rewind()	0	8	2

<?php

declare(strict_types=1);

namespace Arrayy;

/**
 * @internal
 */
final class ArrayyRewindableGenerator implements \Iterator
{
    /**
     * @var callable
     */
    private $generatorFunction;

    /**
     * @var \Generator
     */
    private $generator;

    /**
     * @var callable|null
     */
    private $onRewind;

    /**
     * @param callable $generatorConstructionFunction A callable that should return a Generator
     * @param callable $onRewind                      callable that gets invoked with 0 arguments after the iterator
     *                                                was rewinded
     *
     * @throws \InvalidArgumentException
     */
    public function __construct(callable $generatorConstructionFunction, callable $onRewind = null)
    {
        $this->generatorFunction = $generatorConstructionFunction;
        $this->onRewind = $onRewind;
        $this->generateGenerator();
    }

    private function generateGenerator()
    {
        $this->generator = call_user_func($this->generatorFunction);

        if (!($this->generator instanceof \Generator)) {
            throw new \InvalidArgumentException('The callable needs to return a Generator');
        }
    }

    /**
     * Return the current element.
     *
     * @return mixed
     * @link http://php.net/manual/en/iterator.current.php
     * @see  Iterator::current
     */
    public function current()
    {
        return $this->generator->current();
    }

    /**
     * Move forward to next element.
     *
     * @see  Iterator::next
     * @link http://php.net/manual/en/iterator.next.php
     */
    public function next()
    {
        $this->generator->next();
    }

    /**
     * Return the key of the current element.
     *
     * @return mixed scalar on success, or null on failure.
     * @link http://php.net/manual/en/iterator.key.php
     * @see  Iterator::key
     */
    public function key()
    {
        return $this->generator->key();
    }

    /**
     * Checks if current position is valid.
     *
     * @return boolean
     * @link http://php.net/manual/en/iterator.valid.php
     * @see  Iterator::rewind
     */
    public function valid()
    {
        return $this->generator->valid();
    }

    /**
     * Rewind the Iterator to the first element.
     *
     * @see  Iterator::rewind
     * @link http://php.net/manual/en/iterator.rewind.php
     */
    public function rewind()
    {
        $this->generateGenerator();

        if (is_callable($this->onRewind)) {
            call_user_func($this->onRewind);
        }
    }
}