AbstractIterator.php

Go to the documentation of this file.

<?php
namespace Magento\FunctionalTestingFramework\Util\Iterator;

abstract class AbstractIterator implements \Iterator, \Countable
{
    protected $data = [];

    // @codingStandardsIgnoreStart
    protected $current;

    abstract public function current();
    // @codingStandardsIgnoreEnd

    protected $key;

    abstract protected function isValid();

    public function rewind()
    {
        reset($this->data);
        if (!$this->isValid()) {
            $this->next();
        }
    }

    public function next()
    {
        $this->current = next($this->data);

        if ($this->current !== false) {
            if (!$this->isValid()) {
                $this->next();
            }
        } else {
            $this->key = null;
        }
    }

    public function valid()
    {
        $current = current($this->data);
        if ($current === false || $current === null) {
            return false;
        } else {
            return true;
        }
    }

    public function key()
    {
        return key($this->data);
    }

    public function count()
    {
        return count($this->data);
    }

    protected function initFirstElement()
    {
        if ($this->data) {
            $this->current = reset($this->data);
            if (!$this->isValid()) {
                $this->next();
            }
        }
    }
}