Aura\Marshal\DataIterator

Complexity

Total Complexity

6

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

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

<?php
/**
 *
 * This file is part of the Aura project for PHP.
 *
 * @package Aura.Marshal
 *
 * @license https://opensource.org/licenses/mit-license.php MIT
 *
 */
namespace Aura\Marshal;

use ArrayAccess;

/**
 *
 * An object to allow iteration over the elements of a Data object.
 *
 * @package Aura.Marshal
 * 
 * @implements \Iterator<int|string, mixed>
 *
 */
class DataIterator implements \Iterator
{
    /**
     *
     * The data over which we are iterating.
     *
     * @var ArrayAccess<int|string, mixed>
     *
     */
    protected $data;

    /**
     *
     * The keys to iterate over in the Data object.
     *
     * @var array<int|string>
     *
     */
    protected $keys;

    /**
     *
     * Is the current iterator position valid?
     *
     * @var bool
     *
     */
    protected $valid;

    /**
     *
     * Constructor.
     *
     * @param ArrayAccess<int|string, mixed> $data The Data object over which to iterate.
     *
     * @param array<int|string> $keys The keys in the Data object.
     *
     */
    public function __construct(ArrayAccess $data, array $keys = [])
    {
        $this->data = $data;
        $this->keys = $keys;
    }

    /**
     *
     * Returns the value at the current iterator position.
     *
     * @return mixed
     *
     */
    #[\ReturnTypeWillChange]
    public function current()
    {
        return $this->data->offsetGet($this->key());
    }

    /**
     *
     * Returns the current iterator position.
     *
     * @return mixed
     *
     */
    #[\ReturnTypeWillChange]
    public function key()
    {
        return current($this->keys);
    }

    /**
     *
     * Moves the iterator to the next position.
     *
     * @return void
     *
     */
    #[\ReturnTypeWillChange]
    public function next()
    {
        $this->valid = (next($this->keys) !== false);
    }

    /**
     *
     * Moves the iterator to the first position.
     *
     * @return void
     *
     */
    #[\ReturnTypeWillChange]
    public function rewind()
    {
        $this->valid = (reset($this->keys) !== false);
    }

    /**
     *
     * Is the current iterator position valid?
     *
     * @return bool
     *
     */
    #[\ReturnTypeWillChange]
    public function valid()
    {
        return $this->valid;
    }
}