Smoren\Sequence\Iterators\SequenceIterator

Complexity

Total Complexity

8

Size/Duplication

Total Lines	67
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

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

<?php

declare(strict_types=1);

namespace Smoren\Sequence\Iterators;

use Smoren\Sequence\Interfaces\SequenceInterface;
use Smoren\Sequence\Interfaces\SequenceIteratorInterface;

/**
 * Iterator implementation for sequences.
 *
 * @template T
 * @implements SequenceIteratorInterface<T>
 */
class SequenceIterator implements SequenceIteratorInterface
{
    /**
     * @var SequenceInterface<T> sequence for iterating
     */
    protected SequenceInterface $sequence;
    /**
     * @var int current iteration index
     */
    protected int $currentIndex;
    /**
     * @var T current iteration value

The type Smoren\Sequence\Iterators\T was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    protected $currentValue;

    /**
     * SequenceIterator constructor.
     *
     * @param SequenceInterface<T> $sequence
     */
    public function __construct(SequenceInterface $sequence)
    {
        $this->sequence = $sequence;
        $this->currentIndex = 0;
    }

    /**
     * {@inheritDoc}
     */
    public function current()
    {
        return $this->currentValue;
    }

    /**
     * {@inheritDoc}
     */
    public function next(): void
    {
        $this->currentIndex++;
        $this->currentValue = $this->sequence->getNextValue($this->currentValue);
    }

    /**
     * {@inheritDoc}
     */
    public function key(): int
    {
        return $this->currentIndex;
    }

    /**
     * {@inheritDoc}
     */
    public function valid(): bool
    {
        $count = $this->sequence->isInfinite() ? INF : $this->sequence->count();
        return $this->currentIndex >= 0 && $this->currentIndex < $count;
    }

    /**
     * {@inheritDoc}
     */
    public function rewind(): void
    {
        $this->currentIndex = 0;
        $this->currentValue = $this->sequence->getStartValue();
    }
}