VectorIterator.php 1.86 KB
Newer Older
Qiang Xue committed
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
Qiang Xue committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
 * @license http://www.yiiframework.com/license/
 */

namespace yii\base;

/**
 * VectorIterator implements the SPL `Iterator` interface for [[Vector]].
 *
 * It allows [[Vector]] to return a new iterator for data traversing purpose.
 * You normally do not use this class directly.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class VectorIterator implements \Iterator
{
	/**
	 * @var array the data to be iterated through
	 */
	private $_d;
	/**
	 * @var integer index of the current item
	 */
	private $_i;
	/**
	 * @var integer count of the data items
	 */
	private $_c;

	/**
	 * Constructor.
	 * @param array $data the data to be iterated through
	 */
	public function __construct(&$data)
	{
		$this->_d = &$data;
		$this->_i = 0;
		$this->_c = count($this->_d);
	}

	/**
	 * Rewinds the index of the current item.
	 * This method is required by the SPL interface `Iterator`.
	 */
	public function rewind()
	{
		$this->_i = 0;
	}

	/**
	 * Returns the key of the current item.
	 * This method is required by the SPL interface `Iterator`.
	 * @return integer the key of the current item
	 */
	public function key()
	{
		return $this->_i;
	}

	/**
	 * Returns the current item.
	 * This method is required by the SPL interface `Iterator`.
	 * @return mixed the current item
	 */
	public function current()
	{
		return $this->_d[$this->_i];
	}

	/**
	 * Moves the internal pointer to the next item.
	 * This method is required by the SPL interface `Iterator`.
	 */
	public function next()
	{
		$this->_i++;
	}

	/**
	 * Returns a value indicating whether there is an item at current position.
	 * This method is required by the SPL interface `Iterator`.
	 * @return boolean whether there is an item at current position.
	 */
	public function valid()
	{
		return $this->_i < $this->_c;
	}
}