AppserverIo\Collections\Iter

Complexity

Total Complexity

8

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

88.24%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	2
A	rewind()	0	4	1
A	current()	0	4	1
A	key()	0	4	1
A	next()	0	4	1
A	valid()	0	4	1
A	last()	0	4	1

<?php

/**
 * \AppserverIo\Collections\Iter
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <tw@appserver.io>
 * @copyright 2015 TechDivision GmbH <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/collections
 * @link      http://www.appserver.io
 */

namespace AppserverIo\Collections;

use AppserverIo\Lang\Object;

/**
 * This class is the default implementation of a Iterator
 * used for foreach constructs.
 *
 * @author    Tim Wagner <tw@appserver.io>
 * @copyright 2015 TechDivision GmbH <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/collections
 * @link      http://www.appserver.io
 */
class Iter extends Object implements \Iterator
{

    /**
     * Holds the internal array
     *
     * @var array
     */
    protected $arr = array();

    /**
     * Constructor that initializes the internal member
     * with the array passed as parameter.
     *
     * @param array $array Holds the array
     */
    public function __construct($array)
    {
        if (is_array($array)) {
            $this->arr = $array;
        }
    }

    /**
     * Resets the internal array pointer to
     * the first entry.
     *
     * And returns the value therefore.
     *
     * @return mixed Holds the first value of the internal array
     */
    public function rewind()
    {
        return reset($this->arr);
    }

    /**
     * Returns the actual entry.
     *
     * @return mixed The actual entry of the internal array
     */
    public function current()
    {
        return current($this->arr);
    }

    /**
     * Returns the key of the actual entry.
     *
     * @return mixed The key of actual entry of the internal array
     */
    public function key()
    {
        return key($this->arr);
    }

    /**
     * Returns the next entry.
     *
     * @return mixed The next entry of the internal array
     */
    public function next()
    {
        return next($this->arr);
    }

    /**
     * Checks if the actual entry of the internal
     * array is not false.
     *
     * @return boolean TRUE if there is a actual entry in the internal array, else FALSE
     */
    public function valid()
    {
        return $this->current() !== false;
    }

    /**
     * This method sets the internal array pointer
     * to the end of the array and returns the
     * value therefore.
     *
     * @return mixed Holds the last value of the internal array
     */
    public function last()
    {
        return end($this->arr);
    }
}