php内置函数分析之array_chunk()

 PHP_FUNCTION(array_chunk)
 {
     int argc = ZEND_NUM_ARGS(), num_in;
     zend_long size, current = ;
     zend_string *str_key;
     zend_ulong num_key;
     zend_bool preserve_keys = ;
     zval *input = NULL;
     zval chunk;
     zval *entry;

     if (zend_parse_parameters(argc, "al|b", &input, &size, &preserve_keys) == FAILURE) {
         return;
     }
     /* Do bounds checking for size parameter. */
     /* 如果 size 小于 1，会抛出一个 E_WARNING 错误并返回 NULL。 */
     if (size < ) {
         php_error_docref(NULL, E_WARNING, "Size parameter expected to be greater than 0");
         return;
     }

     /* 原数组大小 */
     num_in = zend_hash_num_elements(Z_ARRVAL_P(input));

     /* 1 <= size <= num_in */
     if (size > num_in) {
         size = num_in >  ? num_in : ;
     }

     /* 初始化返回值 ((num_in - 1) / size) + 1)个元素 */
     array_init_size(return_value, (uint32_t)(((num_in - ) / size) + ));

     // 设置(zval).u1.type_info = IS_UNDEF
     // chunk保存分块后的每个数组
     ZVAL_UNDEF(&chunk);

     ZEND_HASH_FOREACH_KEY_VAL(Z_ARRVAL_P(input), num_key, str_key, entry) {
         /* If new chunk, create and initialize it. */
         // 类型位IS_UNDEF表明，这个chunk是一个新的分块
         if (Z_TYPE(chunk) == IS_UNDEF) {
             // 初始化chunk数组，大小为size
             array_init_size(&chunk, (uint32_t)size);
         }

         /* Add entry to the chunk, preserving keys if necessary. */
         // 是否保存原数组中的键名
         if (preserve_keys) {
             if (str_key) {
                 entry = zend_hash_update(Z_ARRVAL(chunk), str_key, entry);
             } else {
                 entry = zend_hash_index_update(Z_ARRVAL(chunk), num_key, entry);
             }
         } else { // 不保存原数组中的键名，重新索引
             // 数组元素插入chunk
             entry = zend_hash_next_index_insert(Z_ARRVAL(chunk), entry);
         }
         zval_add_ref(entry);

         /* If reached the chunk size, add it to the result array, and reset the
          * pointer. */
         /*chunk大小达到size之后，将chunk加入到返回值数组return_value中，也就是一个分块完成。
         * 然后重置chunk为IS_UNDEF。
         */
         if (!(++current % size)) {
             // chunk加入到return_value
             add_next_index_zval(return_value, &chunk);
             // 重置chunk
             ZVAL_UNDEF(&chunk);
         }
     } ZEND_HASH_FOREACH_END(); 

     /* Add the final chunk if there is one. */
     /* 最后一个数组分块大小达不到size的时候, 将其加到return_value */
     if (Z_TYPE(chunk) != IS_UNDEF) {
         add_next_index_zval(return_value, &chunk);
     }
 }