Spaark\CompositeUtils\Model\Collection\HashMapIterator

Complexity

Total Complexity

5

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getCurrent()	0	4	1
A	rewind()	0	4	1
A	valid()	0	4	1
A	next()	0	6	2

<?php
/**
 * This file is part of the Composite Utils package.
 *
 * (c) Emily Shepherd <emily@emilyshepherd.me>
 *
 * For the full copyright and license information, please view the
 * LICENSE.md file that was distributed with this source code.
 *
 * @package spaark/composite-utils
 * @author Emily Shepherd <emily@emilyshepherd.me>
 * @license MIT
 */

namespace Spaark\CompositeUtils\Model\Collection;

use Spaark\CompositeUtils\Traits\AutoConstructTrait;

/**
 * Iterator for the HashMap datatype
 *
 * @generic KeyType
 * @generic ValueType
 */
class HashMapIterator extends MapIterator
{
    use AutoConstructTrait;

    /**
     * @var Pair<KeyType, ValueType>[]
     * @construct required
     */
    protected $data;

    /**
     * {@inheritDoc}
     */
    public function getCurrent() : Pair
    {
        return current($this->data);
    }

    /**
     * {@inheritDoc}
     */
    public function rewind()
    {
        reset($this->data);
    }

    /**
     * {@inheritDoc}
     */
    public function valid()
    {
        return key($this->data) !== NULL;
    }

    /**
     * {@inheritDoc}
     */
    public function next()
    {
        $next = next($this->data);

        return $next ? $next->value : null;
    }
}