前言
這次,我們將演示如何在PHP擴展中接受傳入的參數(shù)和輸出返回值。
<?php
function default_value ($type, $value = null) {
if ($type == "int") {
return $value ?? 0;
} else if ($type == "bool") {
return $value ?? false;
} else if ($type == "str") {
return is_null($value) ? "" : $value;
}
return null;
}
var_dump(default_value("int"));
var_dump(default_value("int", 1));
var_dump(default_value("bool"));
var_dump(default_value("bool", true));
var_dump(default_value("str"));
var_dump(default_value("str", "a"));
var_dump(default_value("array"));
?>
我們將在擴展中實現(xiàn)default_value
方法挺物。
代碼
基礎(chǔ)代碼
這個擴展椰棘,我們將在say擴展上增加 default_value
方法纺棺。say擴展相關(guān)代碼大家請看這篇博文。PHP7擴展開發(fā)之hello word 文中已經(jīng)詳細(xì)介紹了如何創(chuàng)建一個擴展和提供了源碼下載邪狞。
實現(xiàn)default_value方法
str_concat方法的PHP擴展源碼:
PHP_FUNCTION(default_value)
{
zend_string *type;
zval *value = NULL;
#ifndef FAST_ZPP
/* Get function parameters and do error-checking. */
if (zend_parse_parameters(ZEND_NUM_ARGS(), "S|z", &type, &value) == FAILURE) {
return;
}
#else
ZEND_PARSE_PARAMETERS_START(1, 2)
Z_PARAM_STR(type)
Z_PARAM_OPTIONAL
Z_PARAM_ZVAL_EX(value, 0, 1)
ZEND_PARSE_PARAMETERS_END();
#endif
if (ZSTR_LEN(type) == 3 && strncmp(ZSTR_VAL(type), "int", 3) == 0 && value == NULL) {
RETURN_LONG(0);
} else if (ZSTR_LEN(type) == 3 && strncmp(ZSTR_VAL(type), "int", 3) == 0 && value != NULL) {
RETURN_ZVAL(value, 0, 1);
} else if (ZSTR_LEN(type) == 4 && strncmp(ZSTR_VAL(type), "bool", 4) == 0 && value == NULL) {
RETURN_FALSE;
} else if (ZSTR_LEN(type) == 4 && strncmp(ZSTR_VAL(type), "bool", 4) == 0 && value != NULL) {
RETURN_ZVAL(value, 0, 1);
} else if (ZSTR_LEN(type) == 3 && strncmp(ZSTR_VAL(type), "str", 3) == 0 && value == NULL) {
RETURN_EMPTY_STRING();
} else if (ZSTR_LEN(type) == 3 && strncmp(ZSTR_VAL(type), "str", 3) == 0 && value != NULL) {
RETURN_ZVAL(value, 0, 1);
}
RETURN_NULL();
}
代碼解讀
獲取參數(shù)
在PHP7中提供了兩種獲取參數(shù)的方法祷蝌。zend_parse_parameters
和FAST ZPP方式。
zend_parse_parameters
在PHP7之前一直使用zend_parse_parameters
函數(shù)獲取參數(shù)帆卓。這個函數(shù)的作用巨朦,就是把傳入的參數(shù)轉(zhuǎn)換為PHP內(nèi)核中相應(yīng)的類型,方便在PHP擴展中使用剑令。
參數(shù)說明:
第一個參數(shù)糊啡,參數(shù)個數(shù)。一般就使用ZEND_NUM_ARGS()
吁津,不需要改變棚蓄。
第二個參數(shù),格式化字符串碍脏。這個格式化字符串的作用就是梭依,指定傳入?yún)?shù)與PHP內(nèi)核類型的轉(zhuǎn)換關(guān)系。
代碼中 S|z 的含義就是:
S 表示參數(shù)是一個字符串典尾。要把傳入的參數(shù)轉(zhuǎn)換為zend_string類型役拴。
| 表示之后的參數(shù)是可選〖毓。可以傳河闰,也可以不傳科平。
z 表示參數(shù)是多種類型。要把傳入的參數(shù)轉(zhuǎn)換為zval類型姜性。
除此之外匠抗,還有一些specifier,需要注意:
污抬!如果接收了一個PHP語言里的null變量汞贸,則直接把其轉(zhuǎn)成C語言里的NULL,而不是封裝成IS_NULL類型的zval印机。
/ 如果傳遞過來的變量與別的變量共用一個zval矢腻,而且不是引用,則進行強制分離射赛,新的zval的is_ref__gc==0, and refcount__gc==1.
更多格式化字符串的含義可以查看官方網(wǎng)站多柑。https://wiki.php.net/rfc/fast_zpp
FAST ZPP
在PHP7中新提供的方式。是為了提高參數(shù)解析的性能楣责。對應(yīng)經(jīng)常使用的方法竣灌,建議使用FAST ZPP方式。
使用方式:
以ZEND_PARSE_PARAMETERS_START(1, 2)
開頭秆麸。
第一個參數(shù)表示必傳的參數(shù)格式初嘹,第二個參數(shù)表示最多傳入的參數(shù)個數(shù)。
以ZEND_PARSE_PARAMETERS_END();
結(jié)束沮趣。
中間是傳入?yún)?shù)的解析屯烦。
值得注意的是,一般FAST ZPP的宏方法與zend_parse_parameters的specifier是一一對應(yīng)的房铭。如:
Z_PARAM_ARRAY 對應(yīng) |
Z_PARAM_STR 對應(yīng) S
但是驻龟,Z_PARAM_ZVAL_EX方法比較特殊。它對應(yīng)兩個specifier缸匪,分別是 ! 和 / 翁狐。! 對應(yīng)宏方法的第二個參數(shù)。/ 對應(yīng)宏方法的第三個參數(shù)凌蔬。如果想開啟露懒,只要設(shè)置為1即可。
FAST ZPP相應(yīng)的宏方法可以查看官方網(wǎng)站 https://wiki.php.net/rfc/fast_zpp#proposal
返回值
方法的返回值是使用RETURN_
開頭的宏方法進行返回的龟梦。常用的宏方法有:
RETURN_NULL() 返回null
RETURN_LONG(l) 返回整型
RETURN_DOUBLE(d) 返回浮點型
RETURN_STR(s) 返回一個字符串隐锭。參數(shù)是一個zend_string * 指針
RETURN_STRING(s) 返回一個字符串窃躲。參數(shù)是一個char * 指針
RETURN_STRINGL(s, l) 返回一個字符串计贰。第二個參數(shù)是字符串長度。
RETURN_EMPTY_STRING() 返回一個空字符串蒂窒。
RETURN_ARR(r) 返回一個數(shù)組躁倒。參數(shù)是zend_array *指針荞怒。
RETURN_OBJ(r) 返回一個對象。參數(shù)是zend_object *指針秧秉。
RETURN_ZVAL(zv, copy, dtor) 返回任意類型褐桌。參數(shù)是 zval *指針。
RETURN_FALSE 返回false
RETURN_TRUE 返回true
更多宏方法請查看 Zend/zend_API.h中的相關(guān)代碼象迎。
更多函數(shù)說明請查看