DictionaryIterator.php 2 KB
Newer Older
w  
Qiang Xue committed
1 2
<?php
/**
Qiang Xue committed
3
 * DictionaryIterator class file.
w  
Qiang Xue committed
4 5
 *
 * @link http://www.yiiframework.com/
Qiang Xue committed
6
 * @copyright Copyright &copy; 2008-2012 Yii Software LLC
w  
Qiang Xue committed
7 8 9
 * @license http://www.yiiframework.com/license/
 */

Qiang Xue committed
10 11
namespace yii\base;

w  
Qiang Xue committed
12
/**
Qiang Xue committed
13
 * DictionaryIterator implements the SPL `Iterator` interface for [[Dictionary]].
w  
Qiang Xue committed
14
 *
Qiang Xue committed
15 16
 * It allows [[Dictionary]] to return a new iterator for data traversing purpose.
 * You normally do not use this class directly.
w  
Qiang Xue committed
17 18
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
Qiang Xue committed
19
 * @since 2.0
w  
Qiang Xue committed
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
 */
class DictionaryIterator implements \Iterator
{
	/**
	 * @var array the data to be iterated through
	 */
	private $_d;
	/**
	 * @var array list of keys in the map
	 */
	private $_keys;
	/**
	 * @var mixed current key
	 */
	private $_key;

	/**
	 * Constructor.
	 * @param array $data the data to be iterated through
	 */
	public function __construct(&$data)
	{
Qiang Xue committed
42 43 44
		$this->_d = &$data;
		$this->_keys = array_keys($data);
		$this->_key = reset($this->_keys);
w  
Qiang Xue committed
45 46 47
	}

	/**
Qiang Xue committed
48 49
	 * Rewinds the index of the current item.
	 * This method is required by the SPL interface `Iterator`.
w  
Qiang Xue committed
50 51 52
	 */
	public function rewind()
	{
Qiang Xue committed
53
		$this->_key = reset($this->_keys);
w  
Qiang Xue committed
54 55 56 57
	}

	/**
	 * Returns the key of the current array element.
Qiang Xue committed
58
	 * This method is required by the SPL interface `Iterator`.
w  
Qiang Xue committed
59 60 61 62 63 64 65 66 67
	 * @return mixed the key of the current array element
	 */
	public function key()
	{
		return $this->_key;
	}

	/**
	 * Returns the current array element.
Qiang Xue committed
68
	 * This method is required by the SPL interface `Iterator`.
w  
Qiang Xue committed
69 70 71 72 73 74 75 76
	 * @return mixed the current array element
	 */
	public function current()
	{
		return $this->_d[$this->_key];
	}

	/**
Qiang Xue committed
77 78
	 * Moves the internal pointer to the next element.
	 * This method is required by the SPL interface `Iterator`.
w  
Qiang Xue committed
79 80 81
	 */
	public function next()
	{
Qiang Xue committed
82
		$this->_key = next($this->_keys);
w  
Qiang Xue committed
83 84 85 86
	}

	/**
	 * Returns whether there is an element at current position.
Qiang Xue committed
87 88
	 * This method is required by the SPL interface `Iterator`.
	 * @return boolean whether there is an item at current position.
w  
Qiang Xue committed
89 90 91
	 */
	public function valid()
	{
Qiang Xue committed
92
		return $this->_key !== false;
w  
Qiang Xue committed
93 94
	}
}