php扩展开发实例详解
h1. 一、自动化建立扩展框架
到源码ext目录下
帮助
1
./ext_skel --extname=xiami_ext
生成如下几个文件文件列表：
* CREDITS
* EXPERIMENTAL
* config.m4
* config.w32
* php_xiami_ext.h
* tests
* xiami_ext.c
* xiami_ext.php
.c文件就是C语言系列的源文件，而.h文件则是C语言的头文件，即C系列中存放函数和全局变量的文件。子程序不要定义在*.h中。函数定义要放在*.c中，而*.h只做声明.否则多引用几次，就会发生函数重复定义的错误。
h1. 二、编写函数xiami_hello
h3. 1、不带参数
php_xiami_ext.h
PHP_MINIT_FUNCTION(xiami_ext);
PHP_MSHUTDOWN_FUNCTION(xiami_ext);
PHP_RINIT_FUNCTION(xiami_ext);
PHP_RSHUTDOWN_FUNCTION(xiami_ext);
PHP_MINFO_FUNCTION(xiami_ext);
PHP_FUNCTION(xiami_hello);
xiami_ext.c
const zend_function_entry xiami_ext_functions[] = {
ZEND_FE(confirm_xiami_ext_compiled, NULL)
ZEND_FE(xiami_hello, NULL)
PHP_FE_END
};
ZEND_FUNCTION(xiami_hello)
{
php_printf("Hello World!n");
}
h3. 2、接收外来参数
xiami_ext.c
ZEND_BEGIN_ARG_INFO(arg_xiami_hello, 0)
ZEND_ARG_INFO(0, name)
ZEND_END_ARG_INFO()
ZEND_FUNCTION(xiami_hello)
{
char *name = NULL;
int argc = ZEND_NUM_ARGS();
int name_len;
if (zend_parse_parameters(argc TSRMLS_CC, "s", &name, &name_len) == FAILURE)
return;
php_printf("hello %s",name);
}
const zend_function_entry xiami_ext_functions[] = {
ZEND_FE(confirm_xiami_ext_compiled, NULL)
ZEND_FE(xiami_hello, arg_xiami_hello)
PHP_FE_END
};
以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_NUM_ARGS()代表着参数的个数:
参数 代表着的类型
b Boolean
l Integer 整型
d Floating point 浮点型
s String 字符串
r Resource 资源
a Array 数组
o Object instance 对象
O Object instance of a specified type 特定类型的对象
z Non-specific zval 任意类型～
Z zval**类型
h1. 三、编写类XiamiClass
h3. 1、步骤
# 创建一个全局的zend_class_entry变量，用于存储类的入口。
# 创建一个zend_function_entry结构体数组，用于存储类中包含的方法。
# 在扩展的MINIT方法中注册类。
h3. 2、空类
xiami_ext.c
首先，我们创建一个名为php_xiamiclass_entry的zend_class_entry结构体变量，该结构体变量实际存储了我们创建的类的入口。
zend_class_entry *php_xiamiclass_entry;
这里的php_xiamiclass_entry在扩展源文件中是一个全局变量，为了使其它扩展可以使用我们创建的类，
这个全局变量应该在头文件中定义。
接下来，我们创建zend_function_entry结构体数组，这个数组与函数定义时的数组是一样的。
const zend_function_entry xiami_ext_methods[] = {
PHP_FE_END
};
在MINIT函数中，首先创建了一个xiami_ce变量用于存储临时的类入口，接下来使用INIT_CLASS_ENTRY
宏初始化该变量，之后使用zend_register_internal_class()将该类注册到Zend引擎，
该函数会返回一个最终的类入口，将其赋值给前面创建的全局变量。
PHP_MINIT_FUNCTION(xiami_ext)
{
zend_class_entry xiami_ce;
INIT_CLASS_ENTRY(xiami_ce, "XiamiClass", xiami_ext_methods);
php_xiamiclass_entry = zend_register_internal_class(&xiami_ce TSRMLS_CC);
return SUCCESS;
}
h3. 3、类方法
php_xiami_ext.h
PHP_MINIT_FUNCTION(xiami_ext);
PHP_MSHUTDOWN_FUNCTION(xiami_ext);
PHP_RINIT_FUNCTION(xiami_ext);
PHP_RSHUTDOWN_FUNCTION(xiami_ext);
PHP_MINFO_FUNCTION(xiami_ext);
PHP_METHOD(XiamiClass,__construct);
PHP_METHOD(XiamiClass, set_xiami_age);
xiami_ext.c
ZEND_BEGIN_ARG_INFO_EX(arg_construct, 0, 0, 1)
ZEND_ARG_INFO(0, age)
ZEND_END_ARG_INFO();
ZEND_BEGIN_ARG_INFO(arg_xiami_age, 0)
ZEND_ARG_INFO(0, age)
ZEND_END_ARG_INFO()
PHP_METHOD(XiamiClass, __construct)
{
long age;
if(zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &age) == FAILURE){
WRONG_PARAM_COUNT;
}
if( age <= 0 ) {
age = 1;
}
zend_update_property_long(Z_OBJCE_P(getThis()), getThis(), ZEND_STRL("_age"), age TSRMLS_CC);
RETURN_TRUE;
}
PHP_METHOD(XiamiClass, set_xiami_age)
{
long age;
if(zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &age) == FAILURE){
WRONG_PARAM_COUNT;
}
if( age <= 0 ) {
age = 1;
}
zend_update_property_long(Z_OBJCE_P(getThis()), getThis(), ZEND_STRL("_age"), age TSRMLS_CC);
RETURN_TRUE;
}
PHP_MINIT_FUNCTION(xiami_ext)
{
zend_class_entry xiami_ce;
INIT_CLASS_ENTRY(xiami_ce, "XiamiClass", xiami_ext_methods);
php_xiamiclass_entry = zend_register_internal_class(&xiami_ce TSRMLS_CC);
zend_declare_property_null(php_xiamiclass_entry, ZEND_STRL("_age"), ZEND_ACC_PRIVATE TSRMLS_CC);
return SUCCESS;
}
zend_declare_property_*系列函数:
ZEND_API int zend_declare_property_null(zend_class_entry *ce, char *name, int name_length, int access_type TSRMLS_DC);
用zend_read_property()和zend_update_property()函数：
ZEND_API zval *zend_read_property(zend_class_entry *scope, zval *object, char *name, int name_length, zend_bool silent TSRMLS_DC);
ZEND_API void zend_update_property(zend_class_entry *scope, zval *object, char *name, int name_length, zval *value TSRMLS_DC);
h1. 四、读取ini文件
php_xiami_ext.h
PHP_MINIT_FUNCTION(xiami_ext);
PHP_MSHUTDOWN_FUNCTION(xiami_ext);
PHP_RINIT_FUNCTION(xiami_ext);
PHP_RSHUTDOWN_FUNCTION(xiami_ext);
PHP_MINFO_FUNCTION(xiami_ext);
PHP_FUNCTION(xiami_hello);
ZEND_BEGIN_MODULE_GLOBALS(xiami_ext)
long age;
ZEND_END_MODULE_GLOBALS(xiami_ext)
#ifdef ZTS
#define XIAMI_EXT_G(v) TSRMG(xiami_ext_globals_id, zend_xiami_ext_globals *, v)
#else
#define XIAMI_EXT_G(v) (xiami_ext_globals.v)
#endif
xiami_ext.c
ZEND_DECLARE_MODULE_GLOBALS(xiami_ext)
PHP_INI_BEGIN()
STD_PHP_INI_ENTRY("xiami_ext.age", "42", PHP_INI_ALL, OnUpdateLong, age, zend_xiami_ext_globals, xiami_ext_globals)
PHP_INI_END()
static void php_xiami_ext_init_globals(zend_xiami_ext_globals *xiami_ext_globals)
{
xiami_ext_globals->age = 10;
}
PHP_MINIT_FUNCTION(xiami_ext)
{
ZEND_INIT_MODULE_GLOBALS(xiami_ext, php_xiami_ext_init_globals, NULL);
REGISTER_INI_ENTRIES();
return SUCCESS;
}
ZEND_FUNCTION(xiami_hello)
{
RETURN_LONG(XIAMI_EXT_G(age));
}
const zend_function_entry xiami_ext_functions[] = {
ZEND_FE(xiami_hello, NULL)
PHP_FE_END
};
STD_PHP_INI_ENTRY的最后三个参数是来告诉PHP修改哪个全局变量，我们扩展的全局变量的数据结构，以及这些全局变量被保存到的全局容器的名称。
在php_xiami_ext.h添加的内容中，使用了一对宏ZEND_BEGIN_MODULE_GLOBALS()和ZEND_END_MODULE_GLOBALS() — 用来创建一个包含一个age类型，名为zend_xiami_ext_globals的结构体。然后继续声明了XIAMI_EXT_G()来从一个线程池中获取值，或者只是从全局空间中获取 － 如果你为一个非线程环境编译的话。
在php_xiami_ext.c中你用了ZEND_DECLARE_MODULE_GLOBALS()宏来真正实例化zend_xiami_ext_globals结构体为一个真正的全局变量.最后，在MINIT中，你使用了ZEND_INIT_MODULE_GLOBALS()来分配一个线程安全的资源id.
phpinfo扩展信息中，显示ini信息
PHP_MINFO_FUNCTION(xiami_ext)
{
php_info_print_table_start();
php_info_print_table_header(2, "xiami_ext support", "enabled");
php_info_print_table_end();
DISPLAY_INI_ENTRIES();
}
h1. 五、设置常量
PHP_MINIT_FUNCTION(ggg)
{
zend_constant c;
char *trim_key = "xiami";
char *trim_val = "hello";
int trim_val_len,trim_key_len;
trim_key_len = strlen(trim_key);
trim_val_len = strlen(trim_val);
c.value.type = IS_STRING;
c.value.value.str.val = pestrdup(trim_val, trim_val_len+1);
c.value.value.str.len = trim_val_len;
c.flags = CONST_PERSISTENT | CONST_CS;
c.name = pestrdup(trim_key, trim_key_len+1);
c.name_len = trim_key_len+1;
c.module_number = module_number;
zend_register_constant(&c TSRMLS_CC);
return SUCCESS;
}
h1. 六、资源处理
PHP中的资源类型在内核中是通过一个zend_rsrc_list_entry结构体来实现:
typedef struct _zend_rsrc_list_entry {
void *ptr;
int type;
int refcount;
} zend_rsrc_list_entry;
其中，ptr是一个指向资源的最终实现的指针，例如一个文件句柄，或者一个数据库连接结构。type是一个类型标记，用于区分不同的资源类型。refcount用于资源的引用计数。
资源类型可分为普通的资源，以及持久型的资源。例如mysql普通连接与持久连接。均保存在_zend_executor_globals结构体当中，其中包含如下两个HashTable
struct _zend_executor_globals {
...
HashTable regular_list;
HashTable persistent_list;
...
}
regular_list保存普通资源，persistent_list则保存持久型资源。
要使用资源，先要注册一个资源类型，使用如下的API函数：
ZEND_API int zend_register_list_destructors_ex(rsrc_dtor_func_t ld, rsrc_dtor_func_t pld, const char *type_name, int module_number);
此函数返回一个资源类型id，zend_rsrc_list_entry结构体当中的type成员即对应此值。在扩展当中，此id应作为一个全局变量保存，以传递给其它资源API。
函数的第一及第二个参数，分别对应普通资源及持久资源的析构函数，第三个参数为资源类型的简短名称描述，一般用于错误提示，最后一个参数module_number为引擎内部使用，当我们调用这个函数时，只需要传递一个已经定义好的module_number变量。
static void myfile_dtor(zend_rsrc_list_entry *rsrc TSRMLS_DC){
FILE *fp = (FILE *) rsrc->ptr;
fclose(fp);
}
PHP_MINIT_FUNCTION(myfile) {
//le_myfile是一个用于保存资源类型id的全局变量
le_myfile = zend_register_list_destructors_ex(myfile_dtor,NULL,"standard-c-file", module_number);
return SUCCESS;
要创建一个资源，通过ZEND_REGISTER_RESOURCE()函数：
ZEND_API int zend_register_resource(zval *rsrc_result, void *rsrc_pointer, int rsrc_type TSRMLS_DC);
#define ZEND_REGISTER_RESOURCE(rsrc_result, rsrc_pointer, rsrc_type) zend_register_resource(rsrc_result, rsrc_pointer, rsrc_type TSRMLS_CC);
其第一个参数rsrc_result是一个指向zval的指针，很显然其作用是将PHP变量和资源进行绑定。
第二个参数rsrc_pointer是一个指向资源数据的指针。
第三个参数rsrc_type，很显然，是上面通过zend_register_list_destructors_ex()函数注册所返回的资源类型id。
PHP_FUNCTION(file_open){
char *filename = NULL;
char *mode = NULL;
int argc = ZEND_NUM_ARGS();
int filename_len;
int mode_len;
FILE *fp;
if (zend_parse_parameters(argc TSRMLS_CC, "ss", &filename,&filename_len, &mode, &mode_len) == FAILURE) {
return;
}
fp = fopen(filename, mode);
if (fp == NULL) {
RETURN_FALSE;
}
ZEND_REGISTER_RESOURCE(return_value, fp, le_myfile);
}
要访问一个资源，是通过ZEND_FETCH_RESOURCE()函数来进行的：
ZEND_API void *zend_fetch_resource(zval **passed_id TSRMLS_DC, int default_id, const char *resource_type_name, int *found_resource_type, int num_resource_types, ...);
#define ZEND_VERIFY_RESOURCE(rsrc) if (!rsrc) { RETURN_FALSE; }
#define ZEND_FETCH_RESOURCE(rsrc, rsrc_type, passed_id, default_id, resource_type_name, resource_type) rsrc = (rsrc_type) zend_fetch_resource(passed_id TSRMLS_CC, default_id, resource_type_name, NULL, 1, resource_type); ZEND_VERIFY_RESOURCE(rsrc);
第一个参数rsrc，是要保存资源值所对应的变量名。
第二个参数，是一个指针转换的定义，用于内部将资源转换为正确的类型。
第三个参数，是一个对应的资源值
第四个参数，用于实现资源的默认值
第五个参数，同zend_register_list_destructors_ex()的第三个参数
第六个参数，对应zend_register_list_destructors_ex()的返回值
PHP_FUNCTION(file_write){
char *buffer = NULL;
int argc = ZEND_NUM_ARGS();
int buffer_len;
zval *filehandle = NULL;
FILE *fp;
if (zend_parse_parameters(argc TSRMLS_CC, "rs", &filehandle,&buffer, &buffer_len) == FAILURE) {
return;
}
ZEND_FETCH_RESOURCE(fp, FILE *, &filehandle, -1, "standard-cfile", le_myfile);
if (fwrite(buffer, 1, buffer_len, fp) != buffer_len) {
RETURN_FALSE;
}
RETURN_TRUE;
}
要删除一个资源，则使用zend_list_delete()函数：
ZEND_API int _zend_list_delete(int id TSRMLS_DC);
#define zend_list_delete(id) _zend_list_delete(id TSRMLS_CC)
这个函数仅有一个资源id的参数，返回SUCCESS或者FAILURE。
PHP_FUNCTION(file_close){
int argc = ZEND_NUM_ARGS();
zval *filehandle = NULL;
if (zend_parse_parameters(argc TSRMLS_CC, "r", &filehandle) == FAILURE) {
return;
}
if (zend_list_delete(Z_RESVAL_P(filehandle)) == FAILURE) {
RETURN_FALSE;
}
RETURN_TRUE;
}
参考：
