PHP迭代器接口Iterator用法分析

Iterator extends Traversable {
  //返回当前索引游标指向的元素
  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 )
}

<?php
/
  该类允许外部迭代自己内部私有属性$_test，并演示迭代过程
 
  @author 疯狂老司机
 /
class TestIterator implements Iterator {
  /
    定义要进行迭代的数组
   /
  private $_test = array('dog', 'cat', 'pig');
  /
    索引游标
   /
  private $_key = 0;
  /
    执行步骤
   /
  private $_step = 0;
  /
    将索引游标指向初始位置
   
    @see TestIterator::rewind()
   /
  public function rewind() {
    echo '第'.++$this->_step.'步执行 '.__METHOD__.'<br>';
    $this->_key = 0;
  }
  /
    判断当前索引游标指向的元素是否设置
   
    @see TestIterator::valid()
    @return bool
   /
  public function valid() {
    echo '第'.++$this->_step.'步执行 '.__METHOD__.'<br>';
    return isset($this->_test[$this->_key]);
  }
  /
    将当前索引指向下一位置
   
    @see TestIterator::next()
   /
  public function next() {
    echo '第'.++$this->_step.'步执行 '.__METHOD__.'<br>';
    $this->_key++;
  }
  /
    返回当前索引游标指向的元素的值
   
    @see TestIterator::current()
    @return value
   /
  public function current() {
    echo '第'.++$this->_step.'步执行 '.__METHOD__.'<br>';
    return $this->_test[$this->_key];
  }
  /
    返回当前索引值
   
    @return key
    @see TestIterator::key()
   /
  public function key() {
    echo '第'.++$this->_step.'步执行 '.__METHOD__.'<br>';
    return $this->_key;
  }
}
$iterator = new TestIterator();
foreach($iterator as $key => $value){
  echo "输出索引为{$key}的元素".":$value".'<br><br>';
}
?>

第1步执行 TestIterator::rewind
第2步执行 TestIterator::valid
第3步执行 TestIterator::current
第4步执行 TestIterator::key
输出索引为0的元素:dog
第5步执行 TestIterator::next
第6步执行 TestIterator::valid
第7步执行 TestIterator::current
第8步执行 TestIterator::key
输出索引为1的元素:cat
第9步执行 TestIterator::next
第10步执行 TestIterator::valid
第11步执行 TestIterator::current
第12步执行 TestIterator::key
输出索引为2的元素:pig
第13步执行 TestIterator::next
第14步执行 TestIterator::valid