php内置函数分析之array_column()

PHP_FUNCTION(array_column)
{
    zval *zcolumn = NULL, *zkey = NULL, *data;
    HashTable *arr_hash;
    zval *zcolval = NULL, *zkeyval = NULL, rvc, rvk;

    // !如果接收了一个php语言里的null变量，则直接将其转成C语言里的NULL，而不是封装成IS_NULL类型的zval 
    if (zend_parse_parameters(ZEND_NUM_ARGS(), "hz!|z!", &arr_hash, &zcolumn, &zkey) == FAILURE) {
        return;
    }

    /* 检查colunm和index是否有效（只能为数字和对象，对象需能转换为字符串）。
    *  无效则报The %s key should be either a string or an integer的warning错误。
    */
    if ((zcolumn && !array_column_param_helper(zcolumn, "column")) ||
        (zkey && !array_column_param_helper(zkey, "index"))) {
        RETURN_FALSE;
    }
    // 初始化返回值
    array_init(return_value);
    // 循环遍历数组
    ZEND_HASH_FOREACH_VAL(arr_hash, data) {
        ZVAL_DEREF(data);

        if (!zcolumn) { // column未设置
            zcolval = data;
        } else if ((zcolval = array_column_fetch_prop(data, zcolumn, &rvc)) == NULL) {// 该列的值为NULL,则跳过，进入下一循环
            continue;
        }

        /* Failure will leave zkeyval alone which will land us on the final else block below
         * which is to append the value as next_index
         */
        if (zkey) {
            zkeyval = array_column_fetch_prop(data, zkey, &rvk); // 获取zkey对应的列，作为返回数组的键/索引
        }

        Z_TRY_ADDREF_P(zcolval);
        // 返回值数组：array(zkeyval=>zcolval,...)
        if (zkeyval && Z_TYPE_P(zkeyval) == IS_STRING) {
            zend_symtable_update(Z_ARRVAL_P(return_value), Z_STR_P(zkeyval), zcolval);
        } else if (zkeyval && Z_TYPE_P(zkeyval) == IS_LONG) {
            add_index_zval(return_value, Z_LVAL_P(zkeyval), zcolval);
        } else if (zkeyval && Z_TYPE_P(zkeyval) == IS_OBJECT) {
            zend_string *key = zval_get_string(zkeyval);
            zend_symtable_update(Z_ARRVAL_P(return_value), key, zcolval);
            zend_string_release(key);
        } else {
            // 没有zkeyval，则返回值数组为索引数组
            add_next_index_zval(return_value, zcolval);
        }
        /* 清理内存 */
        if (zcolval == &rvc) {
            zval_ptr_dtor(&rvc);
        }
        if (zkeyval == &rvk) {
            zval_ptr_dtor(&rvk);
        }
    } ZEND_HASH_FOREACH_END();
}