深入了解php自訂函數的參數傳遞

函數的參數

函數的定義只是將函數名稱註冊到函數清單的過程。

1、使用者自訂函數的參數

我們知道對於函數的參數檢查是透過zend_do_receive_arg函數來實現的，在此函數中對於參數的關鍵程式碼如下：

CG(active_op_array)->arg_info = erealloc(CG(active_op_array)->arg_info,
        sizeof(zend_arg_info)*(CG(active_op_array)->num_args));
cur_arg_info = &CG(active_op_array)->arg_info[CG(active_op_array)->num_args-1];
cur_arg_info->name = estrndup(varname->u.constant.value.str.val,
        varname->u.constant.value.str.len);
cur_arg_info->name_len = varname->u.constant.value.str.len;
cur_arg_info->array_type_hint = 0;
cur_arg_info->allow_null = 1;
cur_arg_info->pass_by_reference = pass_by_reference;
cur_arg_info->class_name = NULL;
cur_arg_info->class_name_len = 0;

　整個參數的傳遞是透過給中間程式碼的arg_info欄位執行賦值操作完成。關鍵點是在arg_info字段，arg_info字段的結構如下：

typedef struct _zend_arg_info {
    const char *name;   /*参数的名称*/
    zend_uint name_len;     /*参数名称的长度*/
    const char *class_name; /* 类名*/
     zend_uint class_name_len;   /*类名长度*/
    zend_bool array_type_hint;  /*数组类型提示*/
    zend_bool allow_null;   /*是否允许为NULLͺ*/
    zend_bool pass_by_reference;    /*是否引用传递*/
    zend_bool return_reference; 
    int required_num_args;  
} zend_arg_info;

參數的值傳遞和參數傳遞的區別是透過pass_by_reference參數在產生中間程式碼時實現的。

　　對於參數的個數，中間程式碼中包含的arg_nums欄位在每次執行**zend_do_receive_argxx時都會加1.如下程式碼：

CG(active_op_array)->num_args++;

　　且目前參數的索引為CG( active_op_array)->num_args-1.如下程式碼：

cur_arg_info = &CG(active_op_array)->arg_info[CG(active_op_array)->num_args-1];

　　以上的分析是針對函數定義時的參數設置，這些參數是固定的。而在實際寫程式時可能我們會用到可變參數。此時我們會用到函式func_num_args和func_get_args。它們以內部函數存在。於是在Zend\zend_builtin_functions.c檔中找到這兩個函數的實作。我們先來看func_num_args函數的實現，其程式碼如下：

/* {{{ proto int func_num_args(void)
   Get the number of arguments that were passed to the function */
ZEND_FUNCTION(func_num_args)
{
    zend_execute_data *ex = EG(current_execute_data)->prev_execute_data;
 
    if (ex && ex->function_state.arguments) {
        RETURN_LONG((long)(zend_uintptr_t)*(ex->function_state.arguments));
    } else {
        zend_error(E_WARNING,
"func_num_args():  Called from the global scope - no function context");
        RETURN_LONG(-1);
    }
}
/* }}} */

　在存在ex->function_state.arguments的情況下，及函數呼叫時，傳回ex->function_state.arguments轉換後的值，否則顯示錯誤並返回-1。這裡最關鍵的一點是EG(current_execute_data)。這個變數存放的是當前執行程序或函數的數據，此時我們需要取前一個執行程序的數據，為什麼呢?因為這個函數的呼叫是在進入函數後執行的。函數的相關資料等都在先前執行過程中，於是呼叫的是：

zend_execute_data *ex = EG(current_execute_data)->prev_execute_data;

2、內部函數的參數

以常見的count函數為例，其參數處理部分的程式碼如下：

/* {{{ proto int count(mixed var [, int mode])
   Count the number of elements in a variable (usually an array) */
PHP_FUNCTION(count)
{
    zval *array;
    long mode = COUNT_NORMAL;
 
    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z|l",
         &array, &mode) == FAILURE) {
        return;
    }
    ... //省略
}

　這裡包含了兩個運算：一個是取參數的個數，一個是解析參數清單。

(1)取參數的個數

取參數的個數是透過ZEND_NUM_ARGS()巨集來實現的，定義如下：

#define ZEND_NUM_ARGS()     (ht)

ht是在Zend /zend.h檔案中定義的巨集INTERNAL_FUNCTION_PARAMETERS中的ht，如下

#define INTERNAL_FUNCTION_PARAMETERS int ht, zval *return_value,
zval **return_value_ptr, zval *this_ptr, int return_value_used TSRMLS_DC

(2)解析參數清單

PHP內部函數在解析參數時使用的是zend_parse_parameters。它可以大大簡化參數的接收處理工作，雖然它在處理可變參數時還有點弱。

其宣告如下：

ZEND_API int zend_parse_parameters(int num_args TSRMLS_DC, char *type_spec, 
...)

第一個參數num_args表示表示想要接收的參數個數，我們經常使用ZEND_NUM_ARGS()來表示對傳入的參數「有多少要多少”

第二個參數應該是巨集TSRMLS_CC。

第三個參數type_spec是一個字串，用來指定我們所期待接收的各個參數的類型，有點類似於printf中指定輸出格式的那個格式化字串。

剩下的參數就是我們用來接收PHP參數值的變數的指標。

zend_parse_parameters()在解析參數的同時戶盡可能的轉換參數類型，這樣就可以確保我們總是能得到所期望的類型的變數

以上是深入了解php自訂函數的參數傳遞的詳細內容。更多資訊請關注PHP中文網其他相關文章！