yield和Iterator接口

 Iterator接口的事例 

PHP Iterator接口的作用是允许对象以自己的方式迭代内部的数据，从而使它可以被循环访问，Iterator接口摘要如下：

[php]  view plain  copy

1. Iterator extends Traversable {  
2.     //返回当前索引游标指向的元素  
3.     abstract public mixed current ( void )  
4.     //返回当前索引游标指向的键  
5.     abstract public scalar key ( void )  
6.     //移动当前索引游标到下一元素  
7.     abstract public void next ( void )  
8.     //重置索引游标  
9.     abstract public void rewind ( void )  
10.     //判断当前索引游标指向的元素是否有效  
11.     abstract public boolean valid ( void )  
12. }  

下面是一个简单的例子演示Iterator的使用方法：

[php]  view plain  copy

1. <?php  
2. /** 
3.  * 该类允许外部迭代自己内部私有属性$_test，并演示迭代过程 
4.  * 
5.  * @author 疯狂老司机 
6.  */  
7. class TestIterator implements Iterator {  
8.   
9.     /* 
10.      * 定义要进行迭代的数组 
11.      */  
12.     private $_test = array('dog', 'cat', 'pig');  
13.   
14.     /* 
15.      * 索引游标 
16.      */  
17.     private $_key = 0;  
18.   
19.     /* 
20.      * 执行步骤 
21.      */  
22.     private $_step = 0;  
23.   
24.     /** 
25.      * 将索引游标指向初始位置 
26.      * 
27.      * @see TestIterator::rewind() 
28.      */  
29.     public function rewind() {  
30.         echo '第'.++$this->_step.'步：执行 '.__METHOD__.'<br>';  
31.         $this->_key = 0;  
32.     }  
33.   
34.     /** 
35.      * 判断当前索引游标指向的元素是否设置 
36.      * 
37.      * @see TestIterator::valid() 
38.      * @return bool 
39.      */  
40.     public function valid() {  
41.         echo '第'.++$this->_step.'步：执行 '.__METHOD__.'<br>';  
42.         return isset($this->_test[$this->_key]);  
43.     }  
44.   
45.     /** 
46.      * 将当前索引指向下一位置 
47.      * 
48.      * @see TestIterator::next() 
49.      */  
50.     public function next() {  
51.         echo '第'.++$this->_step.'步：执行 '.__METHOD__.'<br>';  
52.         $this->_key++;  
53.     }  
54.     /** 
55.      * 返回当前索引游标指向的元素的值 
56.      * 
57.      * @see TestIterator::current() 
58.      * @return value 
59.      */  
60.     public function current() {  
61.         echo '第'.++$this->_step.'步：执行 '.__METHOD__.'<br>';  
62.         return $this->_test[$this->_key];  
63.     }  
64.   
65.     /** 
66.      * 返回当前索引值 
67.      * 
68.      * @return key 
69.      * @see TestIterator::key() 
70.      */  
71.     public function key() {  
72.         echo '第'.++$this->_step.'步：执行 '.__METHOD__.'<br>';  
73.         return $this->_key;  
74.     }  
75. }  
76.   
77. $iterator = new TestIterator();  
78. foreach($iterator as $key => $value){  
79.     echo "输出索引为{$key}的元素".":$value".'<br><br>';  
80. }  
81. ?>  

以上例子将输出：

第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

从以上例子可以看出，如果执行valid返回false，则循环就此结束。

迭代生成器

(迭代)生成器也是一个函数,不同的是这个函数的返回值是依次返回,而不是只返回一个单独的值.或者,换句话说,生成器使你能更方便的实现了迭代器接口.下面通过实现一个xrange函数来简单说明：

1. <?php
2. function xrange($start, $end, $step = 1) {
3.     for ($i = $start; $i <= $end; $i += $step) {
4.         yield $i;
5.     }
6. }
7.  
8. foreach (xrange(1, 1000000) as $num) {
9.     echo $num, "\n";
10. }

上面这个xrange()函数提供了和PHP的内建函数range()一样的功能.但是不同的是range()函数返回的是一个包含值从1到100万0的数组(注：请查看手册). 而xrange()函数返回的是依次输出这些值的一个迭代器, 而不会真正以数组形式返回.

这种方法的优点是显而易见的.它可以让你在处理大数据集合的时候不用一次性的加载到内存中.甚至你可以处理无限大的数据流.

当然,也可以不同通过生成器来实现这个功能,而是可以通过继承Iterator接口实现.但通过使用生成器实现起来会更方便,不用再去实现iterator接口中的5个方法了.

生成器为可中断的函数

要从生成器认识协程, 理解它内部是如何工作是非常重要的: 生成器是一种可中断的函数, 在它里面的yield构成了中断点.

还是看上面的例子, 调用xrange(1,1000000)的时候, xrange()函数里代码其实并没有真正地运行. 它只是返回了一个迭代器：

1. <?php
2. $range = xrange(1, 1000000);
3. var_dump($range); // object(Generator)#1
4. var_dump($range instanceof Iterator); // bool(true)
5. ?>

这也解释了为什么xrange叫做迭代生成器, 因为它返回一个迭代器, 而这个迭代器实现了Iterator接口.

调用迭代器的方法一次, 其中的代码运行一次.例如, 如果你调用$range->rewind(), 那么xrange()里的代码就会运行到控制流第一次出现yield的地方. 而函数内传递给yield语句的返回值可以通过$range->current()获取.

为了继续执行生成器中yield后的代码, 你就需要调用$range->next()方法. 这将再次启动生成器, 直到下一次yield语句出现. 因此,连续调用next()和current()方法, 你就能从生成器里获得所有的值, 直到再没有yield语句出现.

对xrange()来说, 这种情形出现在$i超过$end时. 在这中情况下, 控制流将到达函数的终点,因此将不执行任何代码.一旦这种情况发生,vaild()方法将返回假, 这时迭代结束.

PHP Iterator接口的作用是允许对象以自己的方式迭代内部的数据，从而使它可以被循环访问，Iterator接口摘要如下：

[php]  view plain  copy

1. Iterator extends Traversable {  
2.     //返回当前索引游标指向的元素  
3.     abstract public mixed current ( void )  
4.     //返回当前索引游标指向的键  
5.     abstract public scalar key ( void )  
6.     //移动当前索引游标到下一元素  
7.     abstract public void next ( void )  
8.     //重置索引游标  
9.     abstract public void rewind ( void )  
10.     //判断当前索引游标指向的元素是否有效  
11.     abstract public boolean valid ( void )  
12. }  

下面是一个简单的例子演示Iterator的使用方法：

[php]  view plain  copy

1. <?php  
2. /** 
3.  * 该类允许外部迭代自己内部私有属性$_test，并演示迭代过程 
4.  * 
5.  * @author 疯狂老司机 
6.  */  
7. class TestIterator implements Iterator {  
8.   
9.     /* 
10.      * 定义要进行迭代的数组 
11.      */  
12.     private $_test = array('dog', 'cat', 'pig');  
13.   
14.     /* 
15.      * 索引游标 
16.      */  
17.     private $_key = 0;  
18.   
19.     /* 
20.      * 执行步骤 
21.      */  
22.     private $_step = 0;  
23.   
24.     /** 
25.      * 将索引游标指向初始位置 
26.      * 
27.      * @see TestIterator::rewind() 
28.      */  
29.     public function rewind() {  
30.         echo '第'.++$this->_step.'步：执行 '.__METHOD__.'<br>';  
31.         $this->_key = 0;  
32.     }  
33.   
34.     /** 
35.      * 判断当前索引游标指向的元素是否设置 
36.      * 
37.      * @see TestIterator::valid() 
38.      * @return bool 
39.      */  
40.     public function valid() {  
41.         echo '第'.++$this->_step.'步：执行 '.__METHOD__.'<br>';  
42.         return isset($this->_test[$this->_key]);  
43.     }  
44.   
45.     /** 
46.      * 将当前索引指向下一位置 
47.      * 
48.      * @see TestIterator::next() 
49.      */  
50.     public function next() {  
51.         echo '第'.++$this->_step.'步：执行 '.__METHOD__.'<br>';  
52.         $this->_key++;  
53.     }  
54.     /** 
55.      * 返回当前索引游标指向的元素的值 
56.      * 
57.      * @see TestIterator::current() 
58.      * @return value 
59.      */  
60.     public function current() {  
61.         echo '第'.++$this->_step.'步：执行 '.__METHOD__.'<br>';  
62.         return $this->_test[$this->_key];  
63.     }  
64.   
65.     /** 
66.      * 返回当前索引值 
67.      * 
68.      * @return key 
69.      * @see TestIterator::key() 
70.      */  
71.     public function key() {  
72.         echo '第'.++$this->_step.'步：执行 '.__METHOD__.'<br>';  
73.         return $this->_key;  
74.     }  
75. }  
76.   
77. $iterator = new TestIterator();  
78. foreach($iterator as $key => $value){  
79.     echo "输出索引为{$key}的元素".":$value".'<br><br>';  
80. }  
81. ?>  

以上例子将输出：

第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

从以上例子可以看出，如果执行valid返回false，则循环就此结束。

迭代生成器

(迭代)生成器也是一个函数,不同的是这个函数的返回值是依次返回,而不是只返回一个单独的值.或者,换句话说,生成器使你能更方便的实现了迭代器接口.下面通过实现一个xrange函数来简单说明：

1. <?php
2. function xrange($start, $end, $step = 1) {
3.     for ($i = $start; $i <= $end; $i += $step) {
4.         yield $i;
5.     }
6. }
7.  
8. foreach (xrange(1, 1000000) as $num) {
9.     echo $num, "\n";
10. }

上面这个xrange()函数提供了和PHP的内建函数range()一样的功能.但是不同的是range()函数返回的是一个包含值从1到100万0的数组(注：请查看手册). 而xrange()函数返回的是依次输出这些值的一个迭代器, 而不会真正以数组形式返回.

这种方法的优点是显而易见的.它可以让你在处理大数据集合的时候不用一次性的加载到内存中.甚至你可以处理无限大的数据流.

当然,也可以不同通过生成器来实现这个功能,而是可以通过继承Iterator接口实现.但通过使用生成器实现起来会更方便,不用再去实现iterator接口中的5个方法了.

生成器为可中断的函数

要从生成器认识协程, 理解它内部是如何工作是非常重要的: 生成器是一种可中断的函数, 在它里面的yield构成了中断点.

还是看上面的例子, 调用xrange(1,1000000)的时候, xrange()函数里代码其实并没有真正地运行. 它只是返回了一个迭代器：

1. <?php
2. $range = xrange(1, 1000000);
3. var_dump($range); // object(Generator)#1
4. var_dump($range instanceof Iterator); // bool(true)
5. ?>

这也解释了为什么xrange叫做迭代生成器, 因为它返回一个迭代器, 而这个迭代器实现了Iterator接口.

调用迭代器的方法一次, 其中的代码运行一次.例如, 如果你调用$range->rewind(), 那么xrange()里的代码就会运行到控制流第一次出现yield的地方. 而函数内传递给yield语句的返回值可以通过$range->current()获取.

为了继续执行生成器中yield后的代码, 你就需要调用$range->next()方法. 这将再次启动生成器, 直到下一次yield语句出现. 因此,连续调用next()和current()方法, 你就能从生成器里获得所有的值, 直到再没有yield语句出现.

对xrange()来说, 这种情形出现在$i超过$end时. 在这中情况下, 控制流将到达函数的终点,因此将不执行任何代码.一旦这种情况发生,vaild()方法将返回假, 这时迭代结束.