前言

經過上一文 菜鳥學php擴充套件 之 自動生成的擴充套件框架詳解(二) ，對php擴充套件框架的整體瞭解，基本上可以說，對於扯淡如何寫php擴充套件和關鍵點有了一定的把握，但關鍵的還是在於如何寫PHP_FUNCTION的函式。
本文主要記錄一下，php在呼叫擴充套件的時候進行傳參，那麼擴充套件函式是怎麼接招的。當作自己的備忘錄

正文

1.zend_parse_parameters

獲取函式傳遞的引數，可以使用zend_parse_parameters函式，細心的同學會發現官方生成的預設的函式也是用這個函式來接收引數的。

這個函式怎麼用？

首先可以把這個看書當作php的scanf一樣使用。(這個函式不熟悉的自覺

zend_parse_parameters(int num_args TSRMLS_DC, char *type_spec, &引數1,&引數2…);

第一個引數是傳遞給函式的引數個數。通常的做法是傳給它ZEND_NUM_ARGS()。(ZEND_NUM_ARGS() 來表示對傳入的引數“有多少要多少”)這是一個表示傳遞給函式引數總個數的巨集。

第二個引數是為了執行緒安全，總是傳遞TSRMLS_CC巨集。

第三個引數是一個字串，指定了函式期望的引數型別，後面緊跟著需要隨引數值更新的變數列表。由於PHP是弱型別語言，採用鬆散的變數定義和動態的型別判斷，而c語言是強型別的，而zend_parse_parameters()就是為了把不同型別的引數轉化為期望的型別。(當實際的值無法強制轉成期望的型別的時候，會發出一個警告)

第四第五直到第n個引數，都是要傳進來的值的數值。

第三個引數詳解

關於第三個引數，這裡提供一個供選擇的引數列表：

這邊有兩點需要特別注意
1.這裡的字串型別對應的c型別有兩個引數。是的。這說明在使用zend_parse_parameters()函式的時候需要這麼使用：

zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s",&name, &name_len)

一個表示字串內容，另一個是字串長度。

2.需要大概知道一下，zval是啥？
zval是Zend引擎的值容器。無論這個變數是布林型，字串型或者其他任何型別，其資訊總會包含在一個zval聯合體中。來一波zval的結構：

typedef union _zval {

    long lval;

    double dval;

    struct {
        char *val;

        int len;

    } str;

    HashTable *ht;

    zend_object_value obj;

} zval;

ps:關於typedef就不解釋了，因為我發現有人已經寫的非常好了，請點選關於typedef的用法總結

這邊還涉及到額外的三個用法，來增強我們接收引數的能力：

“|”和”!”將在下文有具體例子講解，關於”/”雖然大概懂意思，但沒想到具體的例子。

走一波與php的互動

正常的樣子

在PHP中

<?php
function my_function($msg) {
    echo "我收到引數啦： {$msg}!\n";
}
my_function('咖啡色的羊駝');

如果my_function寫成PHP擴充套件：

ZEND_FUNCTION(my_function) {
    char *msg;
    int msg_len;

    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s",&msg, &msg_len) == FAILURE){
        RETURN_NULL();
    }
    php_printf("我收到引數啦：");
    PHPWRITE(msg, msg_len);
    php_printf("!\n");
}

兩個引數的樣子

在PHP中

<?php
function my_function($email, $msg) {
    echo "我收到引數啦： {$email}、 {$msg}!\n";
}
my_function('[email protected]', '咖啡色的羊駝');

如果my_function寫成PHP擴充套件：

ZEND_FUNCTION(my_function) {
    char *email;
    int email_len;
    char *msg;
    int msg_len;

    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss",&msg, &msg_len,&email, &email_len) == FAILURE){
        RETURN_NULL();
    }
    php_printf("我收到引數啦：");
    PHPWRITE(email, email_len);
    PHPWRITE(msg, msg_len);
    php_printf("!\n");
}

兩個引數,其中一個可選且有預設值

<?php
function my_function($email, $msg = '咖啡色的羊駝') {
    echo "我收到引數啦： {$email}、 {$msg}!\n";
}
my_function('[email protected]');

如果my_function寫成PHP擴充套件：

ZEND_FUNCTION(my_function) {
    char *email;
    int email_len;
    char *msg = "咖啡色的羊駝";
    int msg_len = sizeof("咖啡色的羊駝") - 1;

    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|s",&msg, &msg_len,&email, &email_len) == FAILURE){
        RETURN_NULL();
    }
    php_printf("我收到引數啦：");
    PHPWRITE(email, email_len);
    PHPWRITE(msg, msg_len);
    php_printf("!\n");
}

這裡說明了”｜”的使用

引數為null時，省記憶體的寫法

先來不省的寫法

ZEND_FUNCTION(my_function) {
    zval *val;
    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z",&val) == FAILURE) {
        RETURN_NULL();
    }
}

省記憶體

ZEND_FUNCTION(my_function) {
    zval *val;
    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z!",&val) == FAILURE) {
        RETURN_NULL();
    }
}

這裡例子用上了”!”，每個zval，包括IS_NULL型的zval，都需要佔用一定的記憶體空間，需要cpu的計算資源來為它申請記憶體、初始化，並在它們完成工作後釋放掉。但是很多程式碼都都沒有意識到這一點。有很多程式碼都會把一個null型的值包裹成zval的IS_NULL型別，在擴充套件開發裡這種操作是可以優化的，我們可以把引數接收成C語言裡的NULL。
所以就差了一個！，第二個例子就更省了記憶體。

2.zend_get_arguments()

用法

例子是最好的用法講解，上例子：

ZEND_FUNCTION(my_function) {
    zval *email;
    if (zend_get_parameters(ZEND_NUM_ARGS(), 1, &email)== FAILURE) {
        php_error_docref(NULL TSRMLS_CC, E_WARNING,"至少需要一個引數");
        RETURN_NULL();
    }
    // ... 
}

區別與特點

1.能夠相容老版本的PHP，並且只以zval為載體來接收引數。
2.直接獲取，而不做解析，不會進行型別轉換，所有的引數在擴充套件實現中的載體都需要是zval型別的。
3.接受失敗的時候，不會自己丟擲錯誤，也不能方便的處理有預設值的引數。
4.會自動的把所有符合copy-on-write的zval進行強制分離，生成一個嶄新的copy送到函式內部。

綜合評價：還是用zend_parse_parameters吧，這個函數了解下即可，不給力。

3.zend_get_parameters_ex()

用法

ZEND_FUNCTION(my_function) {
    zval **msg;
    if (zend_get_parameters_ex(1, &msg) == FAILURE) {
        php_error_docref(NULL TSRMLS_CC, E_WARNING,"至少需要一個引數");
        RETURN_NULL();
    }
    // ...
}

不需要ZEND_NUM_ARGS()作為引數，因為它是在是在後期加入的，那個引數已經不再需要了。

區別與特點

1.此函式基本同zend_get_parameters()。
2.唯一不同的是它不會自動的把所有符合copy-on-write的zval進行強制分離，會用到老的zval的特性

綜合評價：極端情況下可能會用到，這個函數了解下即可。

zend_get_parameter_**

這個包括：zend_get_parameters_array_ex()和zend_get_parameters_array()

用法

ZEND_FUNCTION(var_dump) {
    int i, argc = ZEND_NUM_ARGS();
    zval ***args;

    args = (zval ***)safe_emalloc(argc, sizeof(zval **), 0);
    if (ZEND_NUM_ARGS() == 0 || zend_get_parameters_array_ex(argc, args) == FAILURE) {
        efree(args);
        WRONG_PARAM_COUNT;
    }
    for (i=0; i<argc; i++) {
        php_var_dump(args[i], 1 TSRMLS_CC);
    }
    efree(args);
}

這個有點複雜，需要解釋一下：
程式首先獲取引數數量，然後通過safe_emalloc函式申請了相應大小的記憶體來存放這些zval**型別的引數。這裡使用了zend_get_parameters_array_ex()函式來把傳遞給函式的引數填充到args中。
是的
這個引數專門用於解決像php裡面的var_dump的一樣，可以無限傳引數進去的函式的實現

區別與特點

1.用於應對無限引數的擴充套件函式的實現。
2.zend_get_parameters_array與zend_get_parameters_array_ex唯一不同的是它將zval*型別的引數填充到args中，並且需要ZEND_NUM_ARGS()作為引數。

綜合評價:當遇到確實需要處理無限引數的時候，真的要用這個函數了。zend_parse_parameters真的做不到啊～

總結

拋開一切，最少也要學會zend_parse_parameters()的用法。好的。擴充套件函式傳引數的技能get了。