PHP扩展开发(5):参数声明

在开发PHP扩展时,参数信息也需要声明,并通过ZEND_FE宏将函数与参数关联起来,注册到函数表中。大家还记得我们在快速入门篇中的一段代码吧:

ZEND_BEGIN_ARG_INFO(arg_say_goodbye, 0)
ZEND_ARG_INFO(0, name)
ZEND_END_ARG_INFO()

const zend_function_entry fetion_echo_functions[] = {
    PHP_FE(say_goodbye,    arg_say_goodbye)
    {NULL, NULL, NULL}
};

声明扩展函数的参数基本方式如下:

ZEND_BEGIN_ARG_INFO(name, 0|1)
    
    
ZEND_END_ARG_INFO()

以ZEND_BEGIN_ARG_INFO宏定义开始,以ZEND_END_ARG_INFO()结束,这两个宏定义解释如下:

ZEND_BEGIN_ARG_INFO(name, pass_rest_by_reference): 
   开始参数块定义,pass_rest_by_reference为1时,强制所有参数为引用类型 
ZEND_END_ARG_INFO() : 
   结束参数块定义

而每一个参数的定义可以是下列宏定义中的一个:

ZEND_ARG_INFO 声明普通参数
ZEND_ARG_OBJ_INFO 声明对象类型的参数
ZEND_ARG_ARRAY_INFO 声明数组类型的参数
ZEND_ARG_PASS_INFO(pass_by_ref) pass_by_ref为1时,强制设置后续的参数为引用类型

举个例子,如果我们要定义一个函数user_login(username, password),则参数的声明如下:

ZEND_BEGIN_ARG_INFO(arg_user_login, 0)
ZEND_ARG_INFO(0, username)
ZEND_ARG_INFO(0, password)
ZEND_END_ARG_INFO()

根据Zend API宏定义,上面的参数声明展开后,大致如下:

static const zend_arg_info arg_user_login[] = {                                                                       \
        { NULL, 0, NULL, 0, 0, 0, 0, 0, 0 },
    { "username", sizeof(“username“)-1, NULL, 0, 0, 0, 0, 0, 0 },
    { "password", sizeof(“password“)-1, NULL, 0, 0, 0, 0, 0, 0 },
}

可以看到,其实我们定义参数信息展开后就是一个zend_arg_info结构数组,zend_arg_info结构定义如下:

typedef struct _zend_arg_info {
    const char *name;
    zend_uint name_len;
    const char *class_name;
    zend_uint class_name_len;
    zend_bool array_type_hint;
    zend_bool allow_null; 
    zend_bool pass_by_reference; 
    zend_bool return_reference;  
    int required_num_args; 
} zend_arg_info;

下面对各个字段做一解释:

name 参数名称
name_len 参数名称字符串长度
class_name 当参数类型为类时,指定类名称
class_name_len 类名称字符串长度
array_type_hint 标识参数类型是否为数组
allow_null 是否允许设置为空
pass_by_reference 是否设置为引用,即使用&操作符
return_reference 标识函数将重写return_value_ptr,后面介绍函数返回值时再做介绍
required_num_args 设置函数被调用时,传递参数至少为前N个,当设置为-1时,必须传递所有参数

关于PHP扩展的函数参数声明就介绍这么多了,后面的文章我们继续介绍其它内容。

发表评论

电子邮件地址不会被公开。 必填项已用*标注