Tebru\Gson\Internal\AbstractIterator

Complexity

Total Complexity

5

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

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

<?php
/*
 * Copyright (c) Nate Brunette.
 * Distributed under the MIT License (http://opensource.org/licenses/MIT)
 */

namespace Tebru\Gson\Internal;

use Iterator;

/**
 * Class AbstractIterator
 *
 * @author Nate Brunette <n@tebru.net>
 */
abstract class AbstractIterator implements Iterator
{
    /**
     * Queue of elements to be iterated
     *
     * @var array
     */
    protected $queue = [];

    /**
     * Total number of elements in queue
     *
     * @var int
     */
    protected $total = 0;

    /**
     * Cursor position
     *
     * @var int
     */
    protected $iterated = 0;

    /**
     * Return the current element
     *
     * @return mixed
     */
    public function current()
    {
        return $this->queue[$this->iterated][1];
    }

    /**
     * Move forward to next element
     *
     * @return void
     */
    public function next(): void
    {
        $this->iterated++;
    }

    /**
     * Return the key of the current element
     *
     * @return string
     */
    public function key(): string
    {
        return $this->queue[$this->iterated][0];
    }

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

    /**
     * Rewind the Iterator to the first element
     *
     * @return void
     */
    public function rewind(): void
    {
        $this->iterated = 0;
    }
}