NelsonMartell\Collections\CollectionIterator

Complexity

Total Complexity

5

Size/Duplication

Total Lines	32
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	7
Bugs	2	Features	1

6 Methods

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

<?php
/**
 * PHP: Nelson Martell Library file
 *
 * Content:
 * - Trait definition:  [NelsonMartell\Collections]  CollectionIterator
 * - Class definition:  [NelsonMartell\Collections]  Collection
 *
 * Copyright © 2015 Nelson Martell (http://nelson6e65.github.io)
 *
 * Licensed under The MIT License (MIT)
 * For full copyright and license information, please see the LICENSE
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright 2015 Nelson Martell
 * @link      http://nelson6e65.github.io/php_nml/
 * @since     v0.4.0
 * @license   http://www.opensource.org/licenses/mit-license.php The MIT License (MIT)
 * */

namespace NelsonMartell\Collections;

/**
 * Implementa los métodos de la interfaz Iterator para una colección de objetos.
 *
 * @author Nelson Martell <nelson6e65-dev@yahoo.es>
 * @since  v0.4.0
 * */
trait CollectionIterator
{
    private $iteratorPosition = 0;

    public function current()

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->getItem($this->iteratorPosition);
    }

    public function rewind()
    {
        $this->iteratorPosition = 0;
    }

    public function key()

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->iteratorPosition;
    }

    public function next()
    {
        ++$this->iteratorPosition;
    }

    public function valid()
    {
        $v = (bool) ($this->getItem($this->iteratorPosition) != null);

Avoid variables with short names like $v. Configured minimum length is 3.

        return $v;
    }

    protected abstract function getItem($index);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

}

As per coding style, files should not end with a newline character.