[ PHP 内核与扩展开发系列] Array 与 HashTable：在内核中操作数组

由学院君创建于6年前, 最后更新于 6年前版本号 #1 5566 views 2 likes 0 collects

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

创建数组

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

ZEND_FUNCTION(sample_array)
{
    array_init(return_value);
}

返回值是 zval* 类型的，所以我们直接对它调用 array_init() 函数即可，即把它初始化成了一个空数组。

添加元素

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

array_init(arrval);

add_assoc_long(zval *arrval, char *key, long lval);
add_index_long(zval *arrval, ulong idx, long lval);
add_next_index_long(zval *arrval, long lval);

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

// add_assoc_*系列函数：
add_assoc_null(zval *aval, char *key);
add_assoc_bool(zval *aval, char *key, zend_bool bval);
add_assoc_long(zval *aval, char *key, long lval);
add_assoc_double(zval *aval, char *key, double dval);
add_assoc_string(zval *aval, char *key, char *strval, int dup);
add_assoc_stringl(zval *aval, char *key,char *strval, uint strlen, int dup);
add_assoc_zval(zval *aval, char *key, zval *value);

//备注：其实这些函数都是宏，都是对add_assoc_*_ex函数的封装。

// add_index_*系列函数：
ZEND_API int add_index_long(zval *arg, ulong idx, long n);
ZEND_API int add_index_null(zval *arg, ulong idx);
ZEND_API int add_index_bool(zval *arg, ulong idx, int b);
ZEND_API int add_index_resource(zval *arg, ulong idx, int r);
ZEND_API int add_index_double(zval *arg, ulong idx, double d);
ZEND_API int add_index_string(zval *arg, ulong idx, const char *str, int duplicate);
ZEND_API int add_index_stringl(zval *arg, ulong idx, const char *str, uint length, int duplicate);
ZEND_API int add_index_zval(zval *arg, ulong index, zval *value);

// add_next_index_*函数：
ZEND_API int add_next_index_long(zval *arg, long n);
ZEND_API int add_next_index_null(zval *arg);
ZEND_API int add_next_index_bool(zval *arg, int b   );
ZEND_API int add_next_index_resource(zval *arg, int r   );
ZEND_API int add_next_index_double(zval *arg, double d);
ZEND_API int add_next_index_string(zval *arg, const char *str, int duplicate);
ZEND_API int add_next_index_stringl(zval *arg, const char *str, uint length, int duplicate);
ZEND_API int add_next_index_zval(zval *arg, zval *value);

每组函数最后的一个，即 zend..._zval() 函数，允许我们向这个{数组}中添加资源、对象、{数组} 等复合类型的 PHP 变量。

演示示例

下面让我们通过一个例子来演示下它们的用法：

ZEND_FUNCTION(academy_sample_array)
{
    zval *subarray;

    array_init(return_value);

    // 添加标量
    add_assoc_long(return_value, "laravel", 55);
    add_index_bool(return_value, 100, 1);
    add_next_index_double(return_value, 3.1415926);

    // 静态字符串
    add_next_index_string(return_value, "Laravel", 1);

    // 动态字符串
    add_next_index_string(return_value, estrdup("Academy"), 0);

    // 创建一个子数组
    MAKE_STD_ZVAL(subarray);
    array_init(subarray);

    // 使用数值填充数组
    add_next_index_long(subarray, 1);
    add_next_index_long(subarray, 10);
    add_next_index_long(subarray, 100);

    // 将子数组附加到父级数组
    add_index_zval(return_value, 200, subarray);
}

重新编译扩展后，这时如果我们调用用户端 var_dump 这个函数：