PHP7擴展開發之傳參與返回值

前言

此次，咱們將演示如何在PHP擴展中接受傳入的參數和輸出返回值。

<?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"));
?>

咱們將在擴展中實現default_value方法。

代碼

實現default_value方法

default_value方法的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();
}

代碼說明

獲取參數

在PHP7中提供了兩種獲取參數的方法。zend_parse_parameters和FAST ZPP方式。

zend_parse_parameters

在PHP7以前一直使用zend_parse_parameters函數獲取參數。這個函數的做用，就是把傳入的參數轉換爲PHP內核中相應的類型，方便在PHP擴展中使用。
參數說明：
第一個參數，參數個數。通常就使用ZEND_NUM_ARGS()，不須要改變。
第二個參數，格式化字符串。這個格式化字符串的做用就是，指定傳入參數與PHP內核類型的轉換關係。

代碼中 S|z 的含義就是：
S 表示參數是一個字符串。要把傳入的參數轉換爲zend_string類型。
| 表示以後的參數是可選。能夠傳，也能夠不傳。
z 表示參數是多種類型。要把傳入的參數轉換爲zval類型。

除此以外，還有一些specifier，須要注意：
！若是接收了一個PHP語言裏的null變量，則直接把其轉成C語言裏的NULL，而不是封裝成IS_NULL類型的zval。
/ 若是傳遞過來的變量與別的變量共用一個zval，並且不是引用，則進行強制分離，新的zval的is_ref__gc==0, and refcount__gc==1.

更多格式化字符串的含義能夠查看官方網站。https://wiki.php.net/rfc/fast...

FAST ZPP

在PHP7中新提供的方式。是爲了提升參數解析的性能。對應常用的方法，建議使用FAST ZPP方式。
使用方式：
以ZEND_PARSE_PARAMETERS_START(1, 2)開頭。
第一個參數表示必傳的參數個數，第二個參數表示最多傳入的參數個數。
以ZEND_PARSE_PARAMETERS_END();結束。
中間是傳入參數的解析。
值得注意的是，通常FAST ZPP的宏方法與zend_parse_parameters的specifier是一一對應的。如：
Z_PARAM_OPTIONAL 對應 |
Z_PARAM_STR 對應 S
可是，Z_PARAM_ZVAL_EX方法比較特殊。它對應兩個specifier，分別是 ! 和 / 。! 對應宏方法的第二個參數。/ 對應宏方法的第三個參數。若是想開啓，只要設置爲1便可。

FAST ZPP相應的宏方法能夠查看官方網站 https://wiki.php.net/rfc/fast...

返回值

方法的返回值是使用RETURN_開頭的宏方法進行返回的。經常使用的宏方法有：
RETURN_NULL() 返回null
RETURN_LONG(l) 返回整型
RETURN_DOUBLE(d) 返回浮點型
RETURN_STR(s) 返回一個字符串。參數是一個zend_string * 指針
RETURN_STRING(s) 返回一個字符串。參數是一個char * 指針
RETURN_STRINGL(s, l) 返回一個字符串。第二個參數是字符串長度。
RETURN_EMPTY_STRING() 返回一個空字符串。
RETURN_ARR(r) 返回一個數組。參數是zend_array *指針。
RETURN_OBJ(r) 返回一個對象。參數是zend_object *指針。
RETURN_ZVAL(zv, copy, dtor) 返回任意類型。參數是 zval *指針。
RETURN_FALSE 返回false
RETURN_TRUE 返回true

更多宏方法請查看 Zend/zend_API.h中的相關代碼。

加羣交流

[獲取] 完整源碼[解答] 疑難問題歡迎加我微信 1798159444 我把你拉入羣