php扩展开发对于很多朋友来讲都不太可能实现现因为php扩展开发是需要懂c的,下面我来为各位介绍一个　php扩展开发例子吧.

一、自动化建立扩展框架

到源码ext目录下,帮助.

./ext_skel --extname=xiami_ext

生成如下几个文件文件列表:

1. * CREDITS 
2. * EXPERIMENTAL 
3. * config.m4 
4. * config.w32 
5. * php_xiami_ext.h 
6. * tests 
7. * xiami_ext.c 
8. * xiami_ext.php 

.c文件就是C语言系列的源文件,而.h文件则是C语言的头文件,即C系列中存放函数和全局变量的文件,子程序不要定义在*.h中,函数定义要放在*.c中,而*.h只做声明.否则多引用几次,就会发生函数重复定义的错误.

二、编写函数xiami_hello

1、不带参数

1. php_xiami_ext.h 
2.  
3. PHP_MINIT_FUNCTION(xiami_ext); 
4. PHP_MSHUTDOWN_FUNCTION(xiami_ext); 
5. PHP_RINIT_FUNCTION(xiami_ext); 
6. PHP_RSHUTDOWN_FUNCTION(xiami_ext); 
7. PHP_MINFO_FUNCTION(xiami_ext); 
8.  
9. PHP_FUNCTION(xiami_hello); 
10. xiami_ext.c 
11.  
12. const zend_function_entry xiami_ext_functions[] = { 
13.     ZEND_FE(confirm_xiami_ext_compiled, NULL) 
14.     ZEND_FE(xiami_hello,        NULL) 
15.     PHP_FE_END 
16. }; 
17.  
18. ZEND_FUNCTION(xiami_hello) 
19. { 
20.     php_printf("Hello World!n"); 
21. } 

2、接收外来参数

1. xiami_ext.c 
2.  
3. ZEND_BEGIN_ARG_INFO(arg_xiami_hello, 0) 
4. ZEND_ARG_INFO(0, name) 
5. ZEND_END_ARG_INFO() 
6.  
7. ZEND_FUNCTION(xiami_hello) 
8. { 
9.     char *name = NULL; 
10.     int argc = ZEND_NUM_ARGS(); 
11.     int name_len; 
12.  
13.     if (zend_parse_parameters(argc TSRMLS_CC, "s", &name, &name_len) == FAILURE) 
14.         return; 
15.     php_printf("hello %s",name); 
16. } 
17.  
18. const zend_function_entry xiami_ext_functions[] = { 
19.     ZEND_FE(confirm_xiami_ext_compiled, NULL) 
20.     ZEND_FE(xiami_hello,        arg_xiami_hello) 
21.     PHP_FE_END 
22. }; 

以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()代表着参数的个数:

1. 参数   代表着的类型 
2. b   Boolean 
3. l   Integer 整型 
4. d   Floating point 浮点型 
5. s   String 字符串 
6. r   Resource 资源 
7. a   Array 数组 
8. o   Object instance 对象 
9. O   Object instance of a specified type 特定类型的对象 
10. z   Non-specific zval 任意类型～ 
11. Z   zval**类型 

三、编写类XiamiClass

1、步骤

1. # 创建一个全局的zend_class_entry变量，用于存储类的入口。 
2. # 创建一个zend_function_entry结构体数组，用于存储类中包含的方法。 
3. # 在扩展的MINIT方法中注册类。 

2、空类

xiami_ext.c

首先,我们创建一个名为php_xiamiclass_entry的zend_class_entry结构体变量,该结构体变量实际存储了我们创建的类的入口.

zend_class_entry *php_xiamiclass_entry;

这里的php_xiamiclass_entry在扩展源文件中是一个全局变量,为了使其它扩展可以使用我们创建的类,这个全局变量应该在头文件中定义.

接下来,我们创建zend_function_entry结构体数组,这个数组与函数定义时的数组是一样的.

1. const zend_function_entry xiami_ext_methods[] = { 
2.     PHP_FE_END 
3. }; 

在MINIT函数中,首先创建了一个xiami_ce变量用于存储临时的类入口,接下来使用INIT_CLASS_ENTRY 宏初始化该变量,之后使用zend_register_internal_class()将该类注册到Zend引擎,该函数会返回一个最终的类入口,将其赋值给前面创建的全局变量.

1. PHP_MINIT_FUNCTION(xiami_ext) 
2. { 
3.     zend_class_entry xiami_ce; 
4.     INIT_CLASS_ENTRY(xiami_ce, "XiamiClass", xiami_ext_methods); 
5.  
6.     php_xiamiclass_entry = zend_register_internal_class(&xiami_ce TSRMLS_CC); 
7.     return SUCCESS; 
8. } 

3、类方法

1. php_xiami_ext.h 
2.  
3. PHP_MINIT_FUNCTION(xiami_ext); 
4. PHP_MSHUTDOWN_FUNCTION(xiami_ext); 
5. PHP_RINIT_FUNCTION(xiami_ext); 
6. PHP_RSHUTDOWN_FUNCTION(xiami_ext); 
7. PHP_MINFO_FUNCTION(xiami_ext); 
8.  
9. PHP_METHOD(XiamiClass,__construct); 
10. PHP_METHOD(XiamiClass, set_xiami_age); 
11. xiami_ext.c 
12.  
13. ZEND_BEGIN_ARG_INFO_EX(arg_construct, 0, 0, 1) 
14.     ZEND_ARG_INFO(0, age) 
15. ZEND_END_ARG_INFO(); 
16.  
17. ZEND_BEGIN_ARG_INFO(arg_xiami_age, 0) 
18.     ZEND_ARG_INFO(0, age) 
19. ZEND_END_ARG_INFO() 
20.  
21. PHP_METHOD(XiamiClass, __construct) 
22. { 
23.     long age; 
24.     if(zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &age) == FAILURE){ 
25.         WRONG_PARAM_COUNT; 
26.     } 
27.     if( age <= 0 ) { 
28.         age = 1; 
29.     } 
30.  
31.     zend_update_property_long(Z_OBJCE_P(getThis()), getThis(), ZEND_STRL("_age"), age TSRMLS_CC); 
32.     RETURN_TRUE; 
33. } 
34.  
35. PHP_METHOD(XiamiClass, set_xiami_age) 
36. { 
37.     long age; 
38.     if(zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &age) == FAILURE){ 
39.         WRONG_PARAM_COUNT; 
40.     } 
41.     if( age <= 0 ) { 
42.         age = 1; 
43.     } 
44.     zend_update_property_long(Z_OBJCE_P(getThis()), getThis(), ZEND_STRL("_age"), age TSRMLS_CC); 
45.     RETURN_TRUE; 
46. } 
47.  
48. PHP_MINIT_FUNCTION(xiami_ext) 
49. { 
50.     zend_class_entry xiami_ce; 
51.     INIT_CLASS_ENTRY(xiami_ce, "XiamiClass", xiami_ext_methods); 
52.  
53.     php_xiamiclass_entry = zend_register_internal_class(&xiami_ce TSRMLS_CC); 
54.  
55.     zend_declare_property_null(php_xiamiclass_entry, ZEND_STRL("_age"), ZEND_ACC_PRIVATE TSRMLS_CC); 
56.     return SUCCESS; 
57. } 
58. zend_declare_property_*系列函数: 
59.  
60. ZEND_API int zend_declare_property_null(zend_class_entry *ce, char *name, int name_length, int access_type TSRMLS_DC); 
61. 用zend_read_property()和zend_update_property()函数： 
62.  
63. ZEND_API zval *zend_read_property(zend_class_entry *scope, zval *object, char *name, int name_length, zend_bool silent TSRMLS_DC); 
64.  
65. ZEND_API void zend_update_property(zend_class_entry *scope, zval *object, char *name, int name_length, zval *value TSRMLS_DC); 

四、读取ini文件

1. php_xiami_ext.h 
2.  
3. PHP_MINIT_FUNCTION(xiami_ext); 
4. PHP_MSHUTDOWN_FUNCTION(xiami_ext); 
5. PHP_RINIT_FUNCTION(xiami_ext); 
6. PHP_RSHUTDOWN_FUNCTION(xiami_ext); 
7. PHP_MINFO_FUNCTION(xiami_ext); 
8.  
9. PHP_FUNCTION(xiami_hello); 
10. ZEND_BEGIN_MODULE_GLOBALS(xiami_ext) 
11.     long  age; 
12. ZEND_END_MODULE_GLOBALS(xiami_ext) 
13.  
14. #ifdef ZTS 
15. #define XIAMI_EXT_G(v) TSRMG(xiami_ext_globals_id, zend_xiami_ext_globals *, v) 
16. #else 
17. #define XIAMI_EXT_G(v) (xiami_ext_globals.v) 
18. #endif 
19. xiami_ext.c 
20.  
21. ZEND_DECLARE_MODULE_GLOBALS(xiami_ext) 
22.  
23. PHP_INI_BEGIN() 
24.    STD_PHP_INI_ENTRY("xiami_ext.age",      "42", PHP_INI_ALL, OnUpdateLong, age, zend_xiami_ext_globals, xiami_ext_globals) 
25. PHP_INI_END() 
26.  
27. static void php_xiami_ext_init_globals(zend_xiami_ext_globals *xiami_ext_globals) 
28. { 
29.     xiami_ext_globals->age = 10; 
30. } 
31.  
32. PHP_MINIT_FUNCTION(xiami_ext) 
33. { 
34.     ZEND_INIT_MODULE_GLOBALS(xiami_ext, php_xiami_ext_init_globals, NULL); 
35.     REGISTER_INI_ENTRIES(); 
36.  
37.     return SUCCESS; 
38. } 
39.  
40. ZEND_FUNCTION(xiami_hello) 
41. { 
42.     RETURN_LONG(XIAMI_EXT_G(age)); 
43. } 
44.  
45. const zend_function_entry xiami_ext_functions[] = { 
46.     ZEND_FE(xiami_hello,        NULL) 
47.     PHP_FE_END 
48. }; 

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信息.

1. PHP_MINFO_FUNCTION(xiami_ext) 
2. { 
3.     php_info_print_table_start(); 
4.     php_info_print_table_header(2, "xiami_ext support", "enabled"); 
5.     php_info_print_table_end(); 
6.  
7.     DISPLAY_INI_ENTRIES(); 
8. } 

五、设置常量

1. PHP_MINIT_FUNCTION(ggg) 
2. { 
3.     zend_constant c; 
4.     char *trim_key = "xiami"; 
5.     char *trim_val = "hello"; 
6.     int trim_val_len,trim_key_len; 
7.  
8.     trim_key_len = strlen(trim_key); 
9.     trim_val_len = strlen(trim_val); 
10.  
11.     c.value.type = IS_STRING; 
12.     c.value.value.str.val = pestrdup(trim_val, trim_val_len+1); 
13.     c.value.value.str.len = trim_val_len; 
14.     c.flags = CONST_PERSISTENT | CONST_CS; 
15.     c.name = pestrdup(trim_key, trim_key_len+1); 
16.     c.name_len = trim_key_len+1; 
17.     c.module_number = module_number; 
18.     zend_register_constant(&c TSRMLS_CC); 
19.  
20.     return SUCCESS; 
21. } 

六、资源处理

PHP中的资源类型在内核中是通过一个zend_rsrc_list_entry结构体来实现:

1. typedef struct _zend_rsrc_list_entry { 
2.     void *ptr; 
3.     int type; 
4.     int refcount; 
5. } zend_rsrc_list_entry; 

其中,ptr是一个指向资源的最终实现的指针,例如一个文件句柄,或者一个数据库连接结构,type是一个类型标记,用于区分不同的资源类型,refcount用于资源的引用计数.

资源类型可分为普通的资源,以及持久型的资源,例如mysql普通连接与持久连接,均保存在_zend_executor_globals结构体当中,其中包含如下两个HashTable.

1. struct _zend_executor_globals { 
2.     ... 
3.     HashTable regular_list; 
4.     HashTable persistent_list; 
5.     ... 
6. } 

regular_list保存普通资源,persistent_list则保存持久型资源,要使用资源,先要注册一个资源类型,使用如下的API函数:

1. 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变量.

1. static void myfile_dtor(zend_rsrc_list_entry *rsrc TSRMLS_DC){ 
2.      FILE *fp = (FILE *) rsrc->ptr; 
3.      fclose(fp); 
4. } 
5.  
6. PHP_MINIT_FUNCTION(myfile) { 
7.  
8. //le_myfile是一个用于保存资源类型id的全局变量 
9.      le_myfile = zend_register_list_destructors_ex(myfile_dtor,NULL,"standard-c-file", module_number); 
10.      return SUCCESS; 

要创建一个资源,通过ZEND_REGISTER_RESOURCE()函数:

1. ZEND_API int zend_register_resource(zval *rsrc_result, void *rsrc_pointer, int rsrc_type TSRMLS_DC); 
2. #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.

1. PHP_FUNCTION(file_open){ 
2.      char *filename = NULL; 
3.      char *mode = NULL; 
4.      int argc = ZEND_NUM_ARGS(); 
5.      int filename_len; 
6.      int mode_len; 
7.      FILE *fp; 
8.  
9.      if (zend_parse_parameters(argc TSRMLS_CC, "ss", &filename,&filename_len, &mode, &mode_len) == FAILURE) { 
10.           return; 
11.      } 
12.  
13.      fp = fopen(filename, mode); 
14.  
15.      if (fp == NULL) { 
16.           RETURN_FALSE; 
17.      } 
18.  
19.      ZEND_REGISTER_RESOURCE(return_value, fp, le_myfile); 
20. } 

要访问一个资源,是通过ZEND_FETCH_RESOURCE()函数来进行的:

1. 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, ...); 
2. #define ZEND_VERIFY_RESOURCE(rsrc)  if (!rsrc) { RETURN_FALSE; } 
3. #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()的返回值.

1. PHP_FUNCTION(file_write){ 
2.      char *buffer = NULL; 
3.      int argc = ZEND_NUM_ARGS(); 
4.      int buffer_len; 
5.      zval *filehandle = NULL; 
6.      FILE *fp; 
7.  
8.      if (zend_parse_parameters(argc TSRMLS_CC, "rs", &filehandle,&buffer, &buffer_len) == FAILURE) { 
9.           return; 
10.      } 
11.  
12.      ZEND_FETCH_RESOURCE(fp, FILE *, &filehandle, -1, "standard-cfile", le_myfile); 
13.  
14.      if (fwrite(buffer, 1, buffer_len, fp) != buffer_len) { 
15.           RETURN_FALSE; 
16.      } 
17.  
18.      RETURN_TRUE; 
19. } 

要删除一个资源,则使用zend_list_delete()函数:

1. ZEND_API int _zend_list_delete(int id TSRMLS_DC); 
2. #define zend_list_delete(id)  _zend_list_delete(id TSRMLS_CC) 

这个函数仅有一个资源id的参数,返回SUCCESS或者FAILURE.

1. PHP_FUNCTION(file_close){ 
2.      int argc = ZEND_NUM_ARGS(); 
3.      zval *filehandle = NULL; 
4.  
5.      if (zend_parse_parameters(argc TSRMLS_CC, "r", &filehandle) == FAILURE) { 
6.           return; 
7.      } 
8.  
9.      if (zend_list_delete(Z_RESVAL_P(filehandle)) == FAILURE) { 
10.           RETURN_FALSE; 
11.      } 
12.  
13.      RETURN_TRUE; 
14. } 

Tags: php扩展开发 php详解y

分享到：