在上一篇笔记中，我们已经为PHP7增加了一个say()函数，但是细心的你肯定也发现了say()函数执行时只输出了一个字符串“hello world”,我们既无法传递参数进去，也无法更改该函数的返回信息。因此本篇笔记咱们就说说开发PHP扩展时参数传递与返回值处理。
在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"));
- ?>
今天我们就在PHP扩展中实现上述的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_zpp
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_zpp#proposal
返回值
方法的返回值是使用RETURN_开头的宏方法进行返回的。常用的宏方法有：
RETURN_NULL()返回nullRETURN_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返回falseRETURN_TRUE返回true
更多宏方法请查看 Zend/zend_API.h中的相关代码。
下篇笔记波波将分享开发PHP扩展时关于变量类型的处理，敬请期待。
