【PHP】对象遍历

我们知道，php中，foreach可以很方便地对可迭代结构（例如数组，再如对象）进行迭代操作：

foreach( $array as $elem){
	var_dump($elem);
}

foreach($obj as $key=>$value){
	echo "$key=>$value".PHP_EOL;
}

因而我们想：如果对于一个实例化对象，对其进行foreach操作，会发生什么事情呢？

首先我们定义的基础类为：

Class Test{
	/* one public variable */
	public $a;
	
	public $b;
	
	/* one private variable */
	private $c;
	
	public function __construct(){
		$this->a = "public";
		$this->b = "public";
		$this->c = "private";
	}
	
	public function traverseInside(){
		foreach($this as $key=>$value){
			echo $key."=>".$value.EOL;
		}
	}
}

然后我们实例化该类，对其进行迭代，并与内部迭代的结果进行比较：

$test = new Test;
echo "<hr>";
echo "traverse outside:".EOL;
foreach( $test as $key=>$value ){
	echo $key."=>".$value.EOL;
}
echo "<hr>";
echo "traverse inside:".EOL;
$test->traverseInside();

迭代的结果为：

可以看出：外部foreach循环的结果，只是将对象的公有属性（public）循环出来了，而对于私有属性（private）,外部foreach是无法循环出来的。因而我们如果想要在外部通过foreach循环出类的所有的属性（公有的和私有的），仅仅依靠foreach是不行的，必须要对类进行“改造”。如何对类进行改造呢？如果你了解foreach的实现（参考laruence的博客：http://www.laruence.com/2008/11/20/630.html），那么可以很轻松地找到相应的方案。另外一方面，《设计模式-可复用面向对象软件设计的基础》中也提到：通过将对象的访问和遍历从对象中分离出来并放入一个迭代器对象中，迭代器模式可以实现以不同的方式对对象进行遍历。我们暂时不去深挖这句话的意思，只要知道，使用迭代器可以对对象进行遍历即可。

PHP手册<预定义接口>部分指出：要实现迭代器模式，需要在可迭代对象中实现如下接口：

	abstract public mixed current( void )

	abstract public scalar key( void )

	abstract public void next( void )

	abstract public void rewind( void )

	abstract public boolean valid( void )

有了这个。实现迭代器模式就很方便了，一个简单的实例如下：

class TestIterator implements Iterator {
    private $point = 0;
	
    private $data = array(
        "one","two","three",
    );  

    public function __construct() {
        $this->point = 0;
    }

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

    function current() {
        return $this->data[$this->point];
    }

    function key() {
        return $this->point;
    }

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

    function valid() {
        return isset($this->data[$this->point]);
    }
}

$it = new TestIterator;

foreach($it as $key => $value) {
    echo $key, $value;
    echo "\n";
}

当然，使用了迭代器的对象可以以如下方式进行遍历：

$it = new TestIterator;
$it->rewind();

while ($it->valid()){
    $key = $it->key();
    $value = $it->current();
    echo "$key=>$value";
    $it->next();
}

最后附上YII中ListIterator（顾名思义，实现对List的迭代操作的迭代器）的实现：

<?php
/**
 * CListIterator class file.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @link http://www.yiiframework.com/
 * @copyright Copyright © 2008-2011 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

/**
 * CListIterator implements an interator for {@link CList}.
 *
 * It allows CList to return a new iterator for traversing the items in the list.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @version $Id$
 * @package system.collections
 * @since 1.0
 */
class CListIterator 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 internal array pointer.
	 * This method is required by the interface Iterator.
	 */
	public function rewind()
	{
		$this->_i=0;
	}

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

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

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

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