WebHemi\Form\Traits\IteratorTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	57
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

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	6	2
A	rewind()	0	4	1

<?php
/**
 * WebHemi.
 *
 * PHP version 5.6
 *
 * @copyright 2012 - 2016 Gixx-web (http://www.gixx-web.com)
 * @license   https://opensource.org/licenses/MIT The MIT License (MIT)
 *
 * @link      http://www.gixx-web.com
 */
namespace WebHemi\Form\Traits;

use WebHemi\Form\Element\FormElementInterface;

/**
 * Class IteratorTrait
 *
 * @codeCoverageIgnore - general implementation of the Iterator interface.
 */
trait IteratorTrait
{
    /** @var array<FormElementInterface> */
    protected $nodes = [];

    /**
     * Return the current element.
     *
     * @return FormElementInterface
     */
    public function current()
    {
        return current($this->nodes);
    }

    /**
     * Moves the pointer forward to next element.
     *
     * @return void
     */
    public function next()
    {
        next($this->nodes);
    }

    /**
     * Returns the key of the current element.
     *
     * @return mixed
     */
    public function key()
    {
        return key($this->nodes);
    }

    /**
     * Checks if current position is valid.
     *
     * @return boolean
     */
    public function valid()
    {
        $key = key($this->nodes);

        return ($key !== null && $key !== false);
    }

    /**
     * Rewinds the Iterator to the first element.
     *
     * @return void
     */
    public function rewind()
    {
        reset($this->nodes);
    }
}