PHP内核探索：数组操作

当你在扩展中使用HashTable时候，95%是要存储用户端的变量，就像PHP语言中数组那样。为此，内核中已经准备好了相应的工具，来让我们更加的方便的操作HashTable存储zval*，也就是PHP语言中的数组，即IS_ARRAY常量代表的zval，以下用{数组}来代替PHP语言中的数组这个词。

创建数组

创建HashTable有些繁琐，虽然有辅助的宏但还是不能一步完成，而创建数组便简单多了，直接使用array_init(zval *arrval)函数即可，注意它的参数是zval*类型的！这样，我们像用户端返回数组便简单多了：

1ZEND_FUNCTION(sample_array)
2{
3    array_init(return_value);
4}
5 
6//return_value是zval*类型的，所以我们直接对它调用array_init()函数即可，即把它初始化成了一个空数组。

添加元素

将数组初始化后，接下来就要向其添加元素了。因为PHP语言中有多种类型的变量，所以也对应的有多种类型的add_assoc_*()、add_index_*、add_next_index_*()函数。如：

1array_init(arrval);
2 
3add_assoc_long(zval *arrval, char *key, long lval);
4add_index_long(zval *arrval, ulong idx, long lval);
5add_next_index_long(zval *arrval, long lval);

这三个函数的第一个参数都要被操作的{数组}指针，然后是索引值，最后是变量，唯一不同的是add_next_index_long()函数的索引值是其自己计算出来的。根据上一节的内容我们可以知道，这三个函数分别在内部使用了zend_hash_update()、zend_hash_index_update()与zend_hash_next_index_insert函数。

01//add_assoc_*系列函数：
02add_assoc_null(zval *aval, char *key);
03add_assoc_bool(zval *aval, char *key, zend_bool bval);
04add_assoc_long(zval *aval, char *key, long lval);
05add_assoc_double(zval *aval, char *key, double dval);
06add_assoc_string(zval *aval, char *key, char *strval, int dup);
07add_assoc_stringl(zval *aval, char *key,char *strval, uint strlen, intdup);
08add_assoc_zval(zval *aval, char *key, zval *value);
09 
10//备注：其实这些函数都是宏，都是对add_assoc_*_ex函数的封装。
11 
12//add_index_*系列函数：
13ZEND_API int add_index_long     (zval *arg, ulong idx, long n);
14ZEND_API int add_index_null     (zval *arg, ulong idx           );
15ZEND_API int add_index_bool     (zval *arg, ulong idx, int b    );
16ZEND_API int add_index_resource (zval *arg, ulong idx, int r    );
17ZEND_API int add_index_double   (zval *arg, ulong idx, double d);
18ZEND_API int add_index_string   (zval *arg, ulong idx, const char *str, int duplicate);
19ZEND_API int add_index_stringl  (zval *arg, ulong idx, const char *str, uint length, int duplicate);
20ZEND_API int add_index_zval     (zval *arg, ulong index, zval *value);
21 
22//add_next_index_long函数：
23ZEND_API int add_next_index_long        (zval *arg, long n  );
24ZEND_API int add_next_index_null        (zval *arg          );
25ZEND_API int add_next_index_bool        (zval *arg, int b   );
26ZEND_API int add_next_index_resource    (zval *arg, int r   );
27ZEND_API int add_next_index_double      (zval *arg, double d);
28ZEND_API int add_next_index_string      (zval *arg, const char *str, intduplicate);
29ZEND_API int add_next_index_stringl     (zval *arg, const char *str, uint length, int duplicate);
30ZEND_API int add_next_index_zval        (zval *arg, zval *value);

每组函数最后的一个，即zend..._zval()函数，允许我们像这个{数组}中添加资源、对象、{数组}等复合类型的PHP变量。下面让我们通过一个例子来演示下它们的用法：

01ZEND_FUNCTION(sample_array)
02{
03    zval *subarray;
04 
05    array_init(return_value);
06     
07    /* Add some scalars */
08    add_assoc_long(return_value, "life", 42);
09    add_index_bool(return_value, 123, 1);
10    add_next_index_double(return_value, 3.1415926535);
11     
12    /* Toss in a static string, dup'd by PHP */
13    add_next_index_string(return_value, "Foo", 1);
14     
15    /* Now a manually dup'd string */
16    add_next_index_string(return_value, estrdup("Bar"), 0);
17 
18    /* Create a subarray */
19    MAKE_STD_ZVAL(subarray);
20    array_init(subarray);
21     
22    /* Populate it with some numbers */
23    add_next_index_long(subarray, 1);
24    add_next_index_long(subarray, 20);
25    add_next_index_long(subarray, 300);
26     
27    /* Place the subarray in the parent */
28    add_index_zval(return_value, 444, subarray);
29}

这时如果我们用户端var_dump这个函数的返回值便会得到：

1<?php
2var_dump(sample_array());
3?>

输出：

01array(6)
02{
03    ["life"]=> int(42)
04    [123]=> bool(true)
05    [124]=> float(3.1415926535)
06    [125]=> string(3) "Foo"
07    [126]=> string(3) "Bar"
08    [444]=> array(3)
09    {
10        [0]=> int(1)
11        [1]=> int(20)
12        [2]=> int(300)
13    }
14}

Arthur's Blog

创建数组

添加元素

导航

最近发布

友情链接