MaxGoryunov\SavingIterator\Src\ValidAddingIterator

Complexity

Total Complexity

8

Size/Duplication

Total Lines	69
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	2

7 Methods

Rating	Name	Duplication	Size	Complexity
A	key()	0	3	1
A	__construct()	0	9	1
A	next()	0	3	1
A	rewind()	0	3	1
A	current()	0	3	1
A	from()	0	5	2
A	valid()	0	3	1

<?php

namespace MaxGoryunov\SavingIterator\Src;

use Iterator;

/**
 * Adding iterator which only adds values if source is valid.
 * @template TKey
 * @template TValue
 * @implements AddingIterator<TKey, TValue>
 */
final class ValidAddingIterator implements AddingIterator
{

    /**
     * Ctor.
     * 
     * @phpstan-param AddingIterator<TKey, TValue> $origin
     * @param AddingIterator $origin original adding iterator.
     */
    public function __construct(
        /**
         * Original adding iterator.
         *
         * @phpstan-var AddingIterator<TKey, TValue>
         * @var AddingIterator
         */
        private AddingIterator $origin
    ) {
    }

    /**
     * {@inheritDoc}
     * Only adds values if source is valid.
     */
    public function from(Iterator $source): AddingIterator
    {
        return ($source->valid())
            ? new self($this->origin->from($source))
            : $this;
    }

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

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

    /**
     * {@inheritDoc}
     */
    public function next(): void
    {
        $this->origin->next();
    }

    /**
     * {@inheritDoc}
     */
    public function valid(): bool
    {
        return $this->origin->valid();
    }

    /**
     * {@inheritDoc}
     */
    public function rewind(): void
    {
        $this->origin->rewind();
    }
}