php内置函数分析array_diff()

PHP_FUNCTION(array_diff)
{
    zval *args;
    int argc, i;
    uint32_t num;
    HashTable exclude;
    zval *value;
    zend_string *str, *key;
    zend_long idx;
    zval dummy;

    // 至少两个参数
    if (ZEND_NUM_ARGS() < 2) {
        php_error_docref(NULL, E_WARNING, "at least 2 parameters are required, %d given", ZEND_NUM_ARGS());
        return;
    }
    // 类型描述符：*  variable arguments list (0 or more)
    // 类型描述符：+  variable arguments list (1 or more)
    // 参数存放在数组args中，argc保存参数个数
    if (zend_parse_parameters(ZEND_NUM_ARGS(), "+", &args, &argc) == FAILURE) {
        return;
    }

    // 第一个参数不是数组，则报错
    if (Z_TYPE(args[0]) != IS_ARRAY) {
        php_error_docref(NULL, E_WARNING, "Argument #1 is not an array");
        RETURN_NULL(); // 返回NULL
    }

    /* count number of elements */
    // 检查所有参数是否是数组
    num = 0;
    for (i = 1; i < argc; i++) {
        if (Z_TYPE(args[i]) != IS_ARRAY) {
            php_error_docref(NULL, E_WARNING, "Argument #%d is not an array", i + 1);
            RETURN_NULL(); // 返回NULL
        }
        num += zend_hash_num_elements(Z_ARRVAL(args[i])); // 所有参数数组的元素个数累加
    }

    // 元素个数num为0，返回第一个参数数组（空数组）
    if (num == 0) {
        ZVAL_COPY(return_value, &args[0]);
        return;
    }

    ZVAL_NULL(&dummy);
    /* create exclude map */
    zend_hash_init(&exclude, num, NULL, NULL, 0);
    // 从第二个数组开始,所以数组元素保存到exclude
    for (i = 1; i < argc; i++) {
        // 遍历数组
        ZEND_HASH_FOREACH_VAL_IND(Z_ARRVAL(args[i]), value) {
            str = zval_get_string(value); // 数组元素值转为字符串
            zend_hash_add(&exclude, str, &dummy); // 
            zend_string_release(str);
        } ZEND_HASH_FOREACH_END();
    }

    /* copy all elements of first array that are not in exclude set */
    // 初始化返回值数组，大小和第一个数组一致。
    array_init_size(return_value, zend_hash_num_elements(Z_ARRVAL(args[0])));
    // 循环遍历第一个数组
    ZEND_HASH_FOREACH_KEY_VAL_IND(Z_ARRVAL(args[0]), idx, key, value) {
        str = zval_get_string(value); // 元素值转为字符串
        if (!zend_hash_exists(&exclude, str)) { // exclude中找不到该值
            // 插入到返回值数组中（差集），键名保留不变。
            if (key) {
                value = zend_hash_add_new(Z_ARRVAL_P(return_value), key, value);
            } else {
                value = zend_hash_index_add_new(Z_ARRVAL_P(return_value), idx, value);
            }
            zval_add_ref(value);
        }
        zend_string_release(str);
    } ZEND_HASH_FOREACH_END();

    zend_hash_destroy(&exclude);
}