PHP7源码之array_flip函数分析

以下源码基于 PHP 7.3.8

array array_flip ( array $array )
(PHP 4, PHP 5, PHP 7)
array_flip — 交换数组中的键和值

array_flip 函数的源代码在 /ext/standard/array.c 文件中。

/* {{{ proto array array_flip(array input)    Return array with key <-> value flipped */ PHP_FUNCTION(array_flip) { // 定义变量     zval *array, *entry, data;     zend_ulong num_idx;     zend_string *str_idx; // 解析数组参数     ZEND_PARSE_PARAMETERS_START(1, 1)         Z_PARAM_ARRAY(array)     ZEND_PARSE_PARAMETERS_END(); // 初始化返回数组     array_init_size(return_value, zend_hash_num_elements(Z_ARRVAL_P(array))); // 遍历每个元素，并执行键值交换操作     ZEND_HASH_FOREACH_KEY_VAL(Z_ARRVAL_P(array), num_idx, str_idx, entry) {         ZVAL_DEREF(entry);         if (Z_TYPE_P(entry) == IS_LONG) {             if (str_idx) {                 ZVAL_STR_COPY(&data, str_idx);             } else {                 ZVAL_LONG(&data, num_idx);             }             zend_hash_index_update(Z_ARRVAL_P(return_value), Z_LVAL_P(entry), &data);         } else if (Z_TYPE_P(entry) == IS_STRING) {             if (str_idx) {                 ZVAL_STR_COPY(&data, str_idx);             } else {                 ZVAL_LONG(&data, num_idx);             }             zend_symtable_update(Z_ARRVAL_P(return_value), Z_STR_P(entry), &data);         } else {             php_error_docref(NULL, E_WARNING, "Can only flip STRING and INTEGER values!");         }     } ZEND_HASH_FOREACH_END(); } /* }}} */ 参数解析 Z_PARAM_ARRAY

先看参数解析部分

  ZEND_PARSE_PARAMETERS_START(1, 1)         Z_PARAM_ARRAY(array)     ZEND_PARSE_PARAMETERS_END();

Z_PARAM_ARRAY 的主要作用是指定一个参数使数组解析为 zval。关于它的详细资料可以点此查看

Specify a parameter that should parsed as an array into a zval.

返回值 return_value

解析完参数后，返回数组就被初始化了：

array_init_size(return_value, zend_hash_num_elements(Z_ARRVAL_P(array)));

ZEND_FUNCTION 本身不像 PHP 一样用 return 返回值，而是修改 return_value 指针所指向的变量，内核会把 return_value 指向的变量作为用户端调用此函数后得到的返回值。
Z_ARRVAL_P 的定义如下：

#define Z_ARRVAL_P(zval_p)          Z_ARRVAL(*(zval_p))

zend_hash_num_elements 函数代码如下：

#define zend_hash_num_elements(ht) \ (ht)->nNumOfElements

array_init_size 函数代码如下：

define array_init_size(arg, size)  ZVAL_ARR((arg), zend_new_array(size))

返回数组的初始化主要分为 3 步：
Z_ARRVAL_P 宏从 zval 里面提取值到哈希表；
zend_hash_num_elements 提取哈希表元素的个数（nNumOfElements 属性）。
array_init_size 使用 size 变量初始化数组。

键值交换

ZEND_HASH_FOREACH_KEY_VAL 宏定义的内容如下：

#define ZEND_HASH_FOREACH_KEY_VAL(ht, _h, _key, _val) \     ZEND_HASH_FOREACH(ht, 0); \     _h = _p->h; \     _key = _p->key; \     _val = _z;

继续展开 ZEND_HASH_FOREACH：

#define ZEND_HASH_FOREACH(_ht, indirect) do { \         HashTable *__ht = (_ht); \         Bucket *_p = __ht->arData; \         Bucket *_end = _p + __ht->nNumUsed; \         for (; _p != _end; _p++) { \             zval *_z = &_p->val; \             if (indirect && Z_TYPE_P(_z) == IS_INDIRECT) { \                 _z = Z_INDIRECT_P(_z); \             } \             if (UNEXPECTED(Z_TYPE_P(_z) == IS_UNDEF)) continue;

ZEND_HASH_FOREACH_END 的定义如下：

#define ZEND_HASH_FOREACH_END() \         } \     } while (0)

则

ZEND_HASH_FOREACH_KEY_VAL(Z_ARRVAL_P(array), num_idx, str_idx, entry) { // code }

完全展开如下：

do { Bucket *_p = (_ht)->arData; // Z_ARRVAL_P(array) ---> ht ---> _ht Bucket *_end = _p + (_ht)->nNumUsed; // 起始地址+偏移地址 for (; _p != _end; _p++) { zval *_z = &_p->val; if (indirect && Z_TYPE_P(_z) == IS_INDIRECT) { _z = Z_INDIRECT_P(_z); } if (UNEXPECTED(Z_TYPE_P(_z) == IS_UNDEF)) continue; _h = _p->h; // zend_ulong num_idx ---> _h _key = _p->key; // zend_string *str_idx ---> _key _val = _z; // zval *entry ---> _val { //code } } } while (0)

主要作用是迭代一个哈希表的键和值。在上面完全展开的代码中，省略的代码 code 主要实现交换键值。

如果数组元素的索引为数字：

if (Z_TYPE_P(entry) == IS_LONG) { if (str_idx) { ZVAL_STR_COPY(&data, str_idx); } else { ZVAL_LONG(&data, num_idx); } zend_hash_index_update(Z_ARRVAL_P(return_value), Z_LVAL_P(entry), &data); }