php扩展开发对于很多朋友来讲都不太可能实现现因为php扩展开发是需要懂c的,下面我来为各位介绍一个 php扩展开发例子吧.
一、自动化建立扩展框架
到源码ext目录下,帮助.
./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只做声明.否则多引用几次,就会发生函数重复定义的错误.
二、编写函数xiami_hello
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); }
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**类型
三、编写类xiamiclass
1、步骤
# 创建一个全局的zend_class_entry变量,用于存储类的入口。 # 创建一个zend_function_entry结构体数组,用于存储类中包含的方法。 # 在扩展的minit方法中注册类。
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; }
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 四、读取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(); }
五、设置常量
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; }
六、资源处理
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; }
教程地址:
欢迎转载!但请带上文章地址^^