PHP源码阅读笔记二十二：array_splice函数

admin — Thu, 18 Mar 2010 00:53:28 +0000

PHP源码阅读笔记二十二：array_splice函数
array_splice
(PHP 4, PHP 5)

array_splice — 把数组中的一部分去掉并用其它值取代
说明
array array_splice ( array &input, int offset [, int length [, array replacement]] )

array_splice() 把 input 数组中由 offset 和 length 指定的单元去掉，如果提供了 replacement 参数，则用 replacement 数组中的单元取代。返回一个包含有被移除单元的数组。注意 input 中的数字键名不被保留。

如果 offset 为正，则从 input 数组中该值指定的偏移量开始移除。如果 offset 为负，则从 input 末尾倒数该值指定的偏移量开始移除。

如果省略 length，则移除数组中从 offset 到结尾的所有部分。如果指定了 length 并且为正值，则移除这么多单元。如果指定了 length 并且为负值，则移除从 offset 到数组末尾倒数 length 为止中间所有的单元。小窍门：当给出了 replacement 时要移除从 offset 到数组末尾所有单元时，用 count($input) 作为 length。

如果给出了 replacement 数组，则被移除的单元被此数组中的单元替代。如果 offset 和 length 的组合结果是不会移除任何值，则 replacement 数组中的单元将被插入到 offset 指定的位置。注意替换数组中的键名不保留。如果用来替换的值只是一个单元，那么不需要给它加上 array()，除非该单元本身就是一个数组

array_splice函数调用的是php_splice函数，对于此函数的主要代码说明如下：

/* 创建并初始化返回数组，此返回数组为php_splice的返回数组，并非array_splice的返回数组（array_splice的返回数组为removed）*/
ALLOC_HASHTABLE(out_hash);    
zend_hash_init(out_hash, 0, NULL, ZVAL_PTR_DTOR, 0);
/*将数组中从开始到offset的元素拷贝到返回数组中 */
for (pos=0, p=in_hash->pListHead; pos<offset && p ; pos++, p=p->pListNext) {
 
    entry = *((zval **)p->pData);
    entry->refcount++;
/*更新返回数组 */
if (p->nKeyLength)
    zend_hash_quick_update(out_hash, p->arKey, p->nKeyLength, p->h, &entry, sizeof(zval *), NULL);
else
    zend_hash_next_index_insert(out_hash, &entry, sizeof(zval *), NULL);
}
/* 将需要移除的元素赋值给removed，即array_splice的返回数组 */
if (removed != NULL) {
    for ( ; pos<offset+length && p; pos++, p=p->pListNext) {
    entry = *((zval **)p->pData);
    entry->refcount++;
    if (p->nKeyLength)
        zend_hash_quick_update(*removed, p->arKey, p->nKeyLength, p->h, &entry, sizeof(zval *), NULL);
    else
        zend_hash_next_index_insert(*removed, &entry, sizeof(zval *), NULL);
    }
} else /* 其它情况，跳过这些元素 */
    for ( ; pos<offset+length && p; pos++, p=p->pListNext);
/* 如果有元素需要插入，即有replacement参数 */
if (list != NULL) {
/* 对于每个元素，创建新的zval，拷贝并将它写入到返回数组中*/
    for (i=0; i<list_count; i++) {
        entry = *list[i];
        entry->refcount++;
        zend_hash_next_index_insert(out_hash, &entry, sizeof(zval *), NULL);
    }
}
/* 拷贝剩下的元素 */
for ( ; p ; p=p->pListNext) {
    entry = *((zval **)p->pData);
    entry->refcount++;
    if (p->nKeyLength)
        zend_hash_quick_update(out_hash, p->arKey, p->nKeyLength, p->h, &entry, sizeof(zval *), NULL);
    else
        zend_hash_next_index_insert(out_hash, &entry, sizeof(zval *), NULL);
}
 
/* 重置数组的游标，相当于reset函数*/
zend_hash_internal_pointer_reset(out_hash);

整个过程：
1、拷贝从开始到offset的元素到返回数组
2、移除从offset开始到offset＋length的元素
3、如果有替换的元素，将新元素插入到offset后面的位置
4、将offset+length后面的函数插入到返回数组后面
5、重置数组游标

EOF

PHP源码阅读笔记二十一：array_slice函数

admin — Tue, 16 Mar 2010 01:05:39 +0000

PHP源码阅读笔记二十一：array_slice函数
array_slice
(PHP 4, PHP 5)

array_slice — 从数组中取出一段
说明
array array_slice ( array array, int offset [, int length [, bool preserve_keys]] )

array_slice() 返回根据 offset 和 length 参数所指定的 array 数组中的一段序列。

如果 offset 非负，则序列将从 array 中的此偏移量开始。如果 offset 为负，则序列将从 array 中距离末端这么远的地方开始。

如果给出了 length 并且为正，则序列中将具有这么多的单元。如果给出了 length 并且为负，则序列将终止在距离数组末端这么远的地方。如果省略，则序列将从 offset 开始一直到 array 的末端。
这一段说明在程序中的实现非常简单，如下：

1
2
3

while (pos < offset + length && ...) {
.......
}

注意 array_slice() 默认将重置数组的键。自 PHP 5.0.2 起，可以通过将 preserve_keys 设为 TRUE 来改变此行为。
这里所说的重置数组的键，是指重置数组中的数字键。
如下所示PHP代码：


$arr = array(2 => 2, 1 => 1, 's' => 's', '0' => 'ddd');
var_dump(array_slice($arr, 0));
die();
/*
此段程序会输出：array(4) { [0]=> int(2) [1]=> int(1) ["s"]=> string(1) "s" [2]=> string(3) "ddd" }
*/

在源码中我们可以看到：

潘锦的空间 » HashTable

PHP源码阅读笔记二十二：array_splice函数

PHP源码阅读笔记二十一：array_slice函数