類型提示的實現
PHP是弱類型語言,向方法傳遞參數時候也並不嚴格檢查數據類型。 不過有時需要判斷傳遞到方法中的參數,為此PHP中提供了一些函數,來判斷數據的類型。 比如is_numeric(),判斷是否是一個數值或者可轉換為數值的字符串,比如用於判斷對象的類型運算符:instanceof。 instanceof 用來測定一個給定的對象是否來自指定的對象類。instanceof 運算符是 PHP 5 引進的。 在此之前是使用的is_a(),不過現在已經不推薦使用。
為了避免對象類型不規范引起的問題,PHP5中引入了類型提示這個概念。在定義方法參數時,同時定義參數的對象類型。 如果在調用的時候,傳入參數的類型與定義的參數類型不符,則會報錯。這樣就可以過濾對象的類型,或者說保證了數據的安全性。
PHP中的類型提示功能只能用於參數為對象的提示,而無法用於為整數,字串,浮點等類型提示。在PHP5.1之後,PHP支持對數組的類型提示。
要使用類型提示,只要在方法(或函數)的對象型參數前加一個已存在的類的名稱,當使用類型提示時, 你不僅可以指定對象類型,還可以指定抽象類和接口。
一個數組的類型提示示例:
function array_print(Array $arr) {
print_r($arr);}
array_print(1);
以上的這段代碼有一點問題,它觸發了我們這次所介紹的類型提示,這段代碼在PHP5.1之後的版本執行,會報錯如下:
Catchable fatal error: Argument 1 passed to array_print() must be an array,
integer given, called in ...
當我們把函數參數中的整形變量變為數組時,程序會正常運行,調用print_r函數輸出數組。 那麼這個類型提示是如何實現的呢? 不管是在類中的方法,還是我們調用的函數,都是使用function關鍵字作為其聲明的標記, 而類型提示的實現是與函數的聲明相關的,在聲明時就已經確定了參數的類型是哪些,但是需要在調用時才會顯示出來。 這裡,我們從兩個方面說明類型提示的實現:
參數聲明時的類型提示
函數或方法調用時的類型提示
將剛才的那個例子修改一下:
function array_print(Array $arr = 1) {
print_r($arr);}
array_print(array(1));
這段代碼與前面的那個示例相比,函數的參數設置了一個默認值,但是這個默認值是一個整形變量, 它與參數給定的類型提示Array不一樣,因此,當我們運行這段代碼時會很快看到程序會報錯如下:
Fatal error: Default value for parameters with array type hint
can only be an array or NULL
為什麼為很快看到報錯呢? 因為默認值的檢測過程發生在中間代碼生成階段,與運行時的報錯不同,它還沒有生成中間代碼,也沒有執行中間代碼的過程。 在Zend/zend_language_parser.y文件中,我們找到函數的參數列表在編譯時都會調用zend_do_receive_arg函數。 而在這個函數的參數列表中,第5個參數( znode *class_type)與我們這節所要表述的類型提示密切相關。 這個參數的作用是聲明類型提示中的類型,這裡的類型有三種:
空,即沒有類型提示
類名,用戶定義或PHP自定義的類、接口等
數組,編譯期間對應的token是T_ARRAY,即Array字符串
在zend_do_receive_arg函數中,針對class_type參數做了一系列的操作,基本上是針對上面列出的三種類型, 其中對於類名,程序並沒有判斷這個類是否存在,即使你使用了一個不存在的類名, 程序在報錯時,顯示的也會是實參所給的對象並不是給定類的實例。
以上是聲明類型提示的過程以及在聲明過程中對參數默認值的判斷過程,下面我們看下在函數或方法調用時類型提示的實現。
從上面的聲明過程我們知道PHP在編譯類型提示的相關代碼時調用的是Zend/zend_complie.c文件中的zend_do_receive_arg函數, 在這個函數中將類型提示的判斷的opcode被賦值為ZEND_RECV。根據opcode的映射計算規則得出其在執行時調用的是ZEND_RECV_SPEC_HANDLER。 其代碼如下:
static int ZEND_FASTCALL ZEND_RECV_SPEC_HANDLER(ZEND_OPCODE_HANDLER_ARGS){
...//省略
if (param == NULL) {
char *space;
char *class_name = get_active_class_name(&space TSRMLS_CC);
zend_execute_data *ptr = EX(prev_execute_data);
if (zend_verify_arg_type((zend_function *) EG(active_op_array), arg_num, NULL, opline->extended_value TSRMLS_CC)) {
...//省略
}
...//省略
} else {
...//省略
zend_verify_arg_type((zend_function *) EG(active_op_array), arg_num, *param, opline->extended_value TSRMLS_CC);
...//省略
}
...//省略}
如上所示:在ZEND_RECV_SPEC_HANDLER中最後調用的是zend_verify_arg_type。其代碼如下:
static inline int zend_verify_arg_type(zend_function *zf, zend_uint arg_num, zval *arg, ulong fetch_type TSRMLS_DC){
...//省略
if (cur_arg_info->class_name) {
const char *class_name;
if (!arg) {
need_msg = zend_verify_arg_class_kind(cur_arg_info, fetch_type, &class_name, &ce TSRMLS_CC);
return zend_verify_arg_error(zf, arg_num, cur_arg_info, need_msg, class_name, "none", "" TSRMLS_CC);
}
if (Z_TYPE_P(arg) == IS_OBJECT) { // 既然是類對象參數, 傳遞的參數需要是對象類型
// 下面檢查這個對象是否是參數提示類的實例對象, 這裡是允許傳遞子類實例對象
need_msg = zend_verify_arg_class_kind(cur_arg_info, fetch_type, &class_name, &ce TSRMLS_CC);
if (!ce || !instanceof_function(Z_OBJCE_P(arg), ce TSRMLS_CC)) {
return zend_verify_arg_error(zf, arg_num, cur_arg_info, need_msg, class_name, "instance of ", Z_OBJCE_P(arg)->name TSRMLS_CC);
}
} else if (Z_TYPE_P(arg) != IS_NULL || !cur_arg_info->allow_null) { // 參數為NULL, 也是可以通過檢查的,
// 如果函數定義了參數默認值, 不傳遞參數調用也是可以通過檢查的
need_msg = zend_verify_arg_class_kind(cur_arg_info, fetch_type, &class_name, &ce TSRMLS_CC);
return zend_verify_arg_error(zf, arg_num, cur_arg_info, need_msg, class_name, zend_zval_type_name(arg), "" TSRMLS_CC);
}
} else if (cur_arg_info->array_type_hint) { // 數組
if (!arg) {
return zend_verify_arg_error(zf, arg_num, cur_arg_info, "be an array", "", "none", "" TSRMLS_CC);
}
if (Z_TYPE_P(arg) != IS_ARRAY && (Z_TYPE_P(arg) != IS_NULL || !cur_arg_info->allow_null)) {
return zend_verify_arg_error(zf, arg_num, cur_arg_info, "be an array", "", zend_zval_type_name(arg), "" TSRMLS_CC);
}
}
return 1;}
zend_verify_arg_type的整個流程如圖3.1所示:
圖3.1 類型提示判斷流程圖
如果類型提示報錯,zend_verify_arg_type函數最後都會調用 zend_verify_arg_class_kind 生成報錯信息, 並且調用 zend_verify_arg_error 報錯。如下所示代碼:
static inline char * zend_verify_arg_class_kind(const zend_arg_info *cur_arg_info, ulong fetch_type, const char **class_name, zend_class_entry **pce TSRMLS_DC){
*pce = zend_fetch_class(cur_arg_info->class_name, cur_arg_info->class_name_len, (fetch_type | ZEND_FETCH_CLASS_AUTO | ZEND_FETCH_CLASS_NO_AUTOLOAD) TSRMLS_CC);
*class_name = (*pce) ? (*pce)->name: cur_arg_info->class_name;
if (*pce && (*pce)->ce_flags & ZEND_ACC_INTERFACE) {
return "implement interface ";
} else {
return "be an instance of ";
}}
static inline int zend_verify_arg_error(const zend_function *zf, zend_uint arg_num, const zend_arg_info *cur_arg_info, const char *need_msg, const char *need_kind, const char *given_msg, char *given_kind TSRMLS_DC){
zend_execute_data *ptr = EG(current_execute_data)->prev_execute_data;
char *fname = zf->common.function_name;
char *fsep;
char *fclass;
if (zf->common.scope) {
fsep = "::";
fclass = zf->common.scope->name;
} else {
fsep = "";
fclass = "";
}
if (ptr && ptr->op_array) {
zend_error(E_RECOVERABLE_ERROR, "Argument %d passed to %s%s%s() must %s%s, %s%s given, called in %s on line %d and defined", arg_num, fclass, fsep, fname, need_msg, need_kind, given_msg, given_kind, ptr->op_array->filename, ptr->opline->lineno);
} else {
zend_error(E_RECOVERABLE_ERROR, "Argument %d passed to %s%s%s() must %s%s, %s%s given", arg_num, fclass, fsep, fname, need_msg, need_kind, given_msg, given_kind);
}
return 0;}
在上面的代碼中,我們可以找到前面的報錯信息中的一些關鍵字Argument、 passed to、called in等。 這就是我們在調用函數或方法時類型提示顯示錯誤信息的最終執行位置。