php函數的返回值

返回值

用戶空間函數利用return關鍵字向它的調用空間回傳信息, 這一點和C語言的語法相同.

例如:

function sample_long() {  
  return 42;  
}  
$bar = sample_long();

當sample_long()被調用時, 返回42並設置到$bar變量中. 在C語言中的等價代碼如下:

int sample_long(void) {  
  return 42;  
}  
void main(void) {  
  int bar = sample_long();  
}

當然, 在C語言中你總是知道被調用的函數是什麼, 並且基於函數原型返回, 因此相應的你要定義返回結果存儲的變量. 在php用戶空間處理時, 變量類型是動態的, 轉而依賴於第2章"變量的裡裡外外"中介紹的zval的類型.

return_value變量

你可能認為你的內部函數應該直接返回一個zval, 或者說分配一個zval的內存空間並如下返回zval *.

PHP_FUNCTION(sample_long_wrong)  
{  
    zval *retval;  
      
    MAKE_STD_ZVAL(retval);  
    ZVAL_LONG(retval, 42);  
      
    return retval;  
}

不幸的是, 這樣做是不正確的. 並不是強制每個函數實現分配zval並返回它. 而是Zend引擎在函數調用之前預先分配這個空間. 接著將zval的類型初始化為IS_NULL, 並將值作為參數名return_value傳遞. 下面是正確的做法:

PHP_FUNCTION(sample_long)  
{  
    ZVAL_LONG(return_value, 42);  
    return;  
}

要注意的是PHP_FUNCTION()實現並不會直接返回任何值. 取而代之的是直接將恰當的數據彈出到return_value參數中, Zend引擎會在內部函數執行完成後處理它.

友情提示: ZVAL_LONG()宏是對多個賦值操作的一個封裝:

Z_TYPE_P(return_value) = IS_LONG;  
Z_LVAL_P(return_value) = 42;

或者更直接點:

return_value->type = IS_LONG;  
return_value->value.lval = 42;

return_value的is_ref和refcount屬性不應該被內部函數直接修改. 這些值由Zend引擎在調用你的函數時初始化並處理.

現在我們來看看這個特殊的函數, 將它增加到第5章"你的第一個擴展"中創建的sample擴展中. 只需要在sample_hello_world()函數下面添加這個函數, 並將sample_long()加入到php_sample_functions結構體中:

static function_entry php_sample_functions[] = {  
    PHP_FE(sample_hello_world, NULL)  
    PHP_FE(sample_long, NULL)  
    { NULL, NULL, NULL }  
};

現在我們就可以執行make重新構建擴展了.

如果一切OK, 可以運行php並測試新函數:

$ php -r 'var_dump(sample_long());

包裝更緊湊的宏

在代碼可讀性和可維護性方面, ZVAL_*()宏中有重復的部分: return_value變量. 這種情況下, 將宏的ZVAL替換為RETVAL, 我們就可以在調用時省略return_value了.

前面的例子中, sample_long()的實現代碼可以縮減到下面這樣:

PHP_FUNCTION(sample_long)  
{  
    RETVAL_LONG(42);  
    return;  
}