Ktomk\Pipelines\Cli\Args\Iterator

Complexity

Total Complexity

14

Size/Duplication

Total Lines	133
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getNext()	0	3	1
A	__construct()	0	4	1
A	rewind()	0	8	1
A	key()	0	9	1
A	getByIndex()	0	12	3
A	getArgsIndex()	0	7	2
A	next()	0	11	2
A	current()	0	13	2
A	valid()	0	11	1

<?php

/* this file is part of pipelines */

namespace Ktomk\Pipelines\Cli\Args;

use Iterator as PhpIterator;

class Iterator extends Args implements PhpIterator
{
    /**
     * @var Args
     */
    private $args;

    /**
     * @var int
     */
    private $index = 0;

    /**
     * @var array
     */
    private $indexes = array();

    /**
     * Iterator constructor.
     *
     * @param Args $args
     */
    public function __construct(Args $args)
    {
        $this->args = $args;
        $this->rewind();
    }

    /**
     * get next argument (look ahead)
     *
     * @return null|string next argument, null if there is no next argument
     */
    public function getNext()
    {
        return $this->getByIndex($this->index + 1);
    }

    /* Iterator */

    #[\ReturnTypeWillChange]
    /**
     * Return the current element
     *
     * @return null|string
     */
    public function current()
    {
        if (!$this->valid()) {
            return null;
        }

        return $this->getByIndex($this->index);
    }

    #[\ReturnTypeWillChange]
    /**
     * Move forward to next option
     */
    public function next()
    {
        if (!$this->valid()) {
            return;
        }

        $this->index++;
    }

    #[\ReturnTypeWillChange]
    /**
     * Return the key of the current option
     *
     * @return null|int index, zero based, null if no such index/key
     */
    public function key()
    {
        return $this->getArgsIndex($this->index);
    }

    #[\ReturnTypeWillChange]
    /**
     * Checks if current position is valid
     *
     * @return bool
     */
    public function valid()
    {
        $current = $this->getByIndex($this->index);

        return !(null === $current);
    }

    #[\ReturnTypeWillChange]
    /**
     * @return void Any returned value is ignored.
     */
    public function rewind()
    {
        $this->index = 0;
        $this->indexes = array_keys($this->args->arguments);
    }

    /**
     * @param int $index
     *
     * @return null|string argument string or null if not found
     */
    private function getByIndex($index)
    {
        $argsIndex = $this->getArgsIndex($index);
        if (null === $argsIndex) {
            return null;
        }

        if (!isset($this->args->arguments[$argsIndex])) {
            return null;
        }

        return $this->args->arguments[$argsIndex];
    }

    /**
     * @param int $index to retrieve index for
     *
     * @return null|int integer index of the argument, null if there is none
     */
    private function getArgsIndex($index)
    {
        if (!isset($this->indexes[$index])) {
            return null;
        }

        return $this->indexes[$index];
    }
}