PHP7 扩展中如何遍历数组

最近在看 PHP7 源代码并学习如何用开发基于该版本下的 PHP 扩展（以前在老版本下的扩展开发经验实在也不多，正好新引擎可以把起跑线提高一下），下面只是一些笔记。

写好迭代回调函数，有两种回调格式：

// 传值
int callback(zval *val) {
  zvaltmp; // 增加一个临时 zval 避免 convert_to_string 污染原元素
  ZVAL_COPY(&tmp, val);  // 复制 val 的值，在 PHP5 中，需要用 zval_copy_ctor 并重置引用计数，现在貌似不用了
  convert_to_string(&tmp); // 字符串类型转换
 
  // 目的很简单，只是打印出来
  php_printf("The value is: [ ");
  PHPWRITE(Z_STRVAL(tmp), Z_STRLEN(tmp));
  php_printf(" ]");
 
  zval_dtor(&tmp); // 主动释放临时 zval，不然会内存泄漏
 
  return ZEND_HASH_APPLY_KEEP;
}
 
// 传键和值
int callback_args(zval *val, int num_args, va_listargs, zend_hash_key *hash_key) {
  zvaltmp = *val;
  ZVAL_COPY(&tmp, val);
  convert_to_string(&tmp);
 
  // 打印键值对结果
  php_printf("The key is : [ ");
  if (hash_key->key) {
    PHPWRITE(ZSTR_VAL(hash_key->key), ZSTR_LEN(hash_key->key));
  } else {
    php_printf("%ld", hash_key->h);
  }
  php_printf(" ], the value is: [ ");
  PHPWRITE(Z_STRVAL(tmp), Z_STRLEN(tmp));
  php_printf(" ]");
 
  zval_dtor(&tmp);
 
  return ZEND_HASH_APPLY_KEEP;
}

zval *val 是数组里面元素的值 zval， hash_key 是元素的键，它们都是指针，其中 zend_hash_key 的结构定义在 zend_hash.h 中

typedef struct _zend_hash_key {
  zend_ulong h; // 数字键
  zend_string *key; // 字符串键
} zend_hash_key;

回调函数可返回三种常量值：

常量	描述
ZEND_HASH_APPLY_KEEP	返回这个值将完成当前循环，并继续迭代 HashTable 中的下一个值，这等价于在foreach()控制块中执行 continue;
ZEND_HASH_APPLY_STOP	返回这个值将中断迭代，等价于在 foreach() 控制块中执行 break;
ZEND_HASH_APPLY_REMOVE	类似于 ZEND_HASH_APPLY_KEEP ，这个返回值将跳到下⼀次迭代，不过这个返回值同时会导致从原 HashTable 中删除当前元素

假设我们定义了一个 PHP 函数 foo：

PHP_FUNCTION(foo)
{
  // 从参数中获取 arr
  zval *arr;
  if (zend_parse_parameters(ZEND_NUM_ARGS(), "a", &arr) == FAILURE) {
    RETURN_NULL();
  }
 
  // 遍历值
  zend_hash_apply(ZARRVAL_P(arr), callback);
 
  // 遍历键和值
  zend_hash_apply_with_arguments(Z_ARRVAL_P(arr), callback_args, 0);
}

Z_ARRVAL_P 用户返回 zval 结构中的 value.arr 指针