月度归档:2010年04月

PHP 源码阅读笔记二十五:next,current,key函数

PHP 源码阅读笔记二十五:next,current,key函数
key — 从关联数组中取得键名
mixed key ( array &array )
key() 返回数组中当前单元的键名。

此函数通过调用zend_hash.c中的zend_hash_get_current_key_ex实现key值的返回
在zend_hash_get_current_key_ex函数中根据nKeyLength属性判断key为字符串或者数字,然后返回

current — 返回数组中的当前单元
mixed current ( array &array )
每个数组中都有一个内部的指针指向它“当前的”单元,初始指向插入到数组中的第一个单元。
current() 函数返回当前被内部指针指向的数组单元的值,并不移动指针。如果内部指针指向超出了单元列表的末端,current() 返回 FALSE。

此函数通过最终是调用zend_hash_get_current_data_ex函数实现value的返回
zend_hash_get_current_data_ex函数直接返回数组元素中存储的值:
*pData = p->pData;
如果数组中存在false元素,则返回值和没有找到的返回值是一样的,这是一个比较纠结的地方

next — 将数组中的内部指针向前移动一位
mixed next ( array &array )
返回数组内部指针指向的下一个单元的值,或当没有更多单元时返回 FALSE。

next() 和 current() 操作十分类似,只有一点区别,在返回值之前将内部指针向前移动一位。即调用了zend_hash_move_forward(target_hash);
这意味着它返回的是下一个数组单元的值并将数组指针向前移动了一位。如果移动指针的结果是超出了数组单元的末端,则 next() 返回 FALSE。
并且和current()一样,当数组元素中存在false时,next()的返回值也会是false

EOF

PHP源码阅读笔记二十四 :iterator实现中当值为false时无法完成迭代的原因分析

PHP源码阅读笔记二十四 :iterator实现中当值为false时无法完成迭代的原因分析
在前面有一篇文章迭代器的简单实现及Yii框架中的迭代器实现中有一个简单的迭代器的实现,此处遗留了一个问题,当迭代的值中包含false时,使用foreach循环的时候在这个地方就结束了,原因是什么呢?

在鸟哥的blog中,很久以前一篇文章对iterator的实现作了一些说明:http://www.laruence.com/2008/10/31/574.html
但是并没有对false的值的处理作相关说明
顺着鸟哥的思路在Zend/zend_vm_execute.h文件的8131行找到相关的线索,如下所示代码:

1
2
3
4
5
6
7
8
9
10
/*  */
if (!iter || (iter->index > 0 && iter->funcs->valid(iter TSRMLS_CC) == FAILURE)) {
/* reached end of iteration */
if (EG(exception)) {
array->refcount--;
zval_ptr_dtor(&array);
ZEND_VM_NEXT_OPCODE();
}
ZEND_VM_JMP(EX(op_array)->opcodes+opline->op2.u.opline_num);
}

对于实现的简单的迭代器,iter->funcs->valid(iter TSRMLS_CC) 方法调用的valid()方法,
如果我们的值为false时,通过current返回的值为false,此时通过foreach访问时,遍历就在此中断了,程序会继续执行下面的代码,而不是这个循环了

解决方案
将数组中的key和value分开处理
在valid(),rewind(),next()方法中操作key,而不是value
仅在current中返回value
如文章迭代器的简单实现及Yii框架中的迭代器实现中的Yii框架中的CMapIterator的实现

PHP中迭代器的简单实现及Yii框架中的迭代器实现

PHP中迭代器的简单实现及Yii框架中的迭代器实现
在维基百科中我们可以看到其定义如下:
迭代器有时又称光标(cursor)是程式设计的软件设计模式,可在容器物件(container,例如list或vector)上遍访的接口,设计人员无需关心容器物件的内容。
各种语言实作Iterator的方式皆不尽同,有些面向对象语言像Java, C#, Python, Delphi都已将Iterator的特性内建语言当中,完美的跟语言整合,我们称之隐式迭代器(implicit iterator),但像是C++语言本身就没有Iterator的特色,但STL仍利用template实作了功能强大的iterator。
Iterator另一方面还可以整合Generator。有些语言将二者视为同一接口,有些语言则将之独立化。
地址:http://zh.wikipedia.org/zh-cn/%E8%BF%AD%E4%BB%A3%E5%99%A8
【Iterator的简单实现】

1
2
3
4
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
/**
* Iterator模式的简单实现类
*/
class sample implements Iterator {
    private $_items ;
 
    public function __construct(&$data) {
        $this->_items = $data;
    }
    public function current() {
        return current($this->_items);
    }
 
    public function next() {
        next($this->_items);   
    }
 
    public function key() {
        return key($this->_items);
    }
 
    public function rewind() {
        reset($this->_items);
    }
 
    public function valid() {                                                                              
        return ($this->current() !== FALSE);
    }
}
 
/** DEMO */
$data = array(1, 2, 3, 4, 5);
$sa = new sample($data);
foreach ($sa AS $key => $row) {
    echo $key, ' ', $row, '<br />';
}

在next()方法的实现时有过纠结,一直以为这里需要返回下一个的值,
这是因为一直以为这里的next就是next函数的实现,但是非也
在手册中我们可以看到其定义为
abstract public void Iterator::next ( void )
其返回值类型为void
所以这里我们调用next函数就可以了,没有必要返回
另外,以上实现对于如下的数组是存在的问题
$data = array(’0′ => 11, ” => 22, ‘s3′ => 33, 0, 0, ”, false, 0, 1);
运行结果是输出:
0 11
22
s3 33
1 0
2 0
3
false后面的值就没有迭代显示出来了,具体原因还不清楚,留作下回分解
在yii框架中也有实现迭代器,它的实现避免了这个问题。

【Yii框架中的迭代器实现】
在Yii框架中的我们可以看到其迭代器的实现
在collections目录下的CMapIterator.php文件中,其实现如下:

1
2
3
4
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
class CMapIterator 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 the data to be iterated through
*/
    public function __construct(&$data) {
        $this->_d=&$data;
        $this->_keys=array_keys($data);
    }
 
/**
* Rewinds internal array pointer.
* This method is required by the interface Iterator.
*/
    public function rewind() {                                                                                 
        $this->_key=reset($this->_keys);
    }
 
/**
* Returns the key of the current array element.
* This method is required by the interface Iterator.
* @return mixed the key of the current array element
*/
    public function key() {
        return $this->_key;
    }
 
/**
* Returns the current array element.
* This method is required by the interface Iterator.
* @return mixed the current array element
*/
    public function current() {
        return $this->_d[$this->_key];
    }
 
/**
* Moves the internal pointer to the next array element.
* This method is required by the interface Iterator.
*/
    public function next() {
        $this->_key=next($this->_keys);
    }
 
/**
* Returns whether there is an element at current position.
* This method is required by the interface Iterator.
* @return boolean
*/
    public function valid() {
        return $this->_key!==false;
    }
}
 
$data = array('s1' => 11, 's2' => 22, 's3' => 33);
$it = new CMapIterator($data);
foreach ($it as $row) {
    echo $row, '<br />';
}

这与之前的简单实现相比,其位置的变化是通过控制key来实现的,这种实现的作用是为了避免false作为数组值时无法迭代