内容简介:[ PHP 内核与扩展开发系列] 类与面向对象:如何定义一个类
zend_class_entry
zend_class_entry
是内核中定义的一个结构体,是内核实现 PHP 语言中类与对象的一个非常基础、关键的结构类型,相当于我们定义类的原型。如果我们想获得一个名字为 myclass
的类该怎么做呢?首先我们定义一个 zend_class_entry
变量,并为它设置名字,最后注册到 runtime 中去:
zend_class_entry *myclass_ce; static zend_function_entry myclass_method[] = { { NULL, NULL, NULL } }; ZEND_MINIT_FUNCTION(academy_sample_class) { zend_class_entry ce; //myclass是这个类的名称 INIT_CLASS_ENTRY(ce, "myclass", myclass_method); myclass_ce = zend_register_internal_class(&ce TSRMLS_CC); return SUCCESS; }
这样我们便定义了一个类 myclass
,而且我们可以在 PHP 语言中使用它,比如:
<?php $obj = new myclass();
我们上面还定义了一个 myclass_ce
指针,它是干什么用的呢?当我们在扩展中对这个类进行操作,比如生成实例的时候,会使用到它,它的作用就类似于打开文件的操作句柄。
定义类对应 zend_class_entry
在这一节中,我们正式的定义一个类。首先我给出 PHP 语言的实现:
<?php class myclass { public $public_var; private $private_var; protected $protected_var; public static $static_var; public function __construct() { echo "我是__construct方法\n"; } public function public_method() { echo "我是public类型的方法\n"; } private function private_method() { echo "我是private类型的方法\n"; } protected function protected_method() { echo "我是protected类型的方法\n"; } public static function static_var() { echo "我是static类型的方法\n"; } }
定义类的第一步,便是先定义好这个类的 zend_class_entry,这一步操作是在 MINIT
阶段完成的。
static zend_function_entry myclass_method[] = { {NULL,NULL,NULL} }; PHP_MINIT_FUNCTION(test) { zend_class_entry ce; INIT_CLASS_ENTRY(ce, "myclass", myclass_method); zend_register_internal_class(&ce TSRMLS_CC); return SUCCESS; }
这就是最简单的一个类,没有属性没有方法,但是可以使用了:
<?php $obj = new myclass(); var_dump($obj);
输出如下:
object(myclass)#1 (0) {}
注:记得将源码 zend_module_entry 中的 /* MINIT */`
部分替换成 ZEND_MINIT(test)`
,否则无法找到 myclass
。
某个类的 zend_class_entry 会经常用到,所以我们一般会把它保存在一个变量里,供扩展中其它地方的程序使用,所以上述的代码组合一般是这样的:
zend_class_entry *myclass_ce; static zend_function_entry myclass_method[] = { {NULL,NULL,NULL} }; ZEND_MINIT_FUNCTION(test) { zend_class_entry ce; INIT_CLASS_ENTRY(ce, "myclass", myclass_method); myclass_ce = zend_register_internal_class(&ce TSRMLS_CC); return SUCCESS; }
为类定义属性
我们可以用 zend_declare_property*
系列函数来完成这项操作,为某个类定义属性一般会需要三个信息:
- 属性的名称
- 属性的默认值
- 属性的访问权限
我们为上面的 myclass
类定义一个名为 public_var
的属性,默认值为 null
,访问权限为 public
:
ZEND_MINIT_FUNCTION(test) { zend_class_entry ce; INIT_CLASS_ENTRY(ce, "myclass", myclass_method); myclass_ce = zend_register_internal_class(&ce TSRMLS_CC); //定义属性 zend_declare_property_null(myclass_ce, "public_var", strlen("public_var"), ZEND_ACC_PUBLIC TSRMLS_CC); return SUCCESS; }
ZEND_ACC_PUBLIC
是 ZEND_ACC
系列掩码中的一个,代表着 public
,其余的还有 ZEND_ACC_PRIVATE
、 ZEND_ACC_PROTECTED
等,详细描述请见后面的章节。这三个掩码比较简单,就不再叙述了。
为类定义方法
为类定义方法比较繁琐一些,首先我们先回顾一下 zend_function_entry 结构,在以前我们用它来保存我们扩展的函数,通过它把 PHP 语言中的函数和我们用 C 语言编写的函数联系起来,在这它也发挥了这么一个桥梁的作用。下面我们来实现 myclass
类的 public 方法和构造方法。
首先,定义这个函数的 C 语言部分,不过这一次我们使用的是 ZEND_METHOD
:
ZEND_METHOD(myclass, public_method) { php_printf("我是public_method方法\n"); } ZEND_METHOD(myclass, __construct) { php_printf("我是__construct方法\n"); }
然后,用 PHP_METHOD
声明 public_method
和 __construct
:
PHP_METHOD(myclass, public_method); PHP_METHOD(myclass, __construct); // 再定义一个zend_function_entry zend_function_entry myclass_method[]= { ZEND_ME(myclass, public_method, NULL, ZEND_ACC_PUBLIC) ZEND_ME(myclass, __construct, NULL, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR) {NULL, NULL, NULL} };
最后,在 MINIT
阶段 register internal class 的时候将它作为一个参数传递进去:
ZEND_MINIT_FUNCTION(test) { zend_class_entry ce; //这里使用了 myclass_method 这个 zend_function_entry INIT_CLASS_ENTRY(ce, "myclass", myclass_method); myclass_ce = zend_register_internal_class(&ce TSRMLS_CC); return SUCCESS; }
现在我们在 PHP 脚本中调用一下这个方法,看看输出结果:
<?php $obj = new myclass(); $obj->public_method();
输出结果如下:
我是__construct方法 我是public_method方法
这里在定义 __construct
方法的时候,使用到了 ZEND_ACC_CTOR
,它的作用便是声明这个方法是此类的构造函数,而 ZEND_ACC_PUBLIC|ZEND_ACC_CTOR
是我们常见的掩码或运算,代表它是一个public 类型的构造函数。如果我们去掉 ZEND_ACC_CTOR
标志,那么此构造函数还会起作用吗?在这里的例子中它仍然起作用,但是在别的环境下我就不敢保证了。
protected
和 private
类型的属性与方法的定义和 public
的一样。而定义 static
的属性与方法只是在掩码标志中加入 ZEND_ACC_STATIC
即可。下面详细地罗列出了所有掩码, fn_flags
代表可以在定义方法时使用, zend_property_info.flags
代表可以在定义属性时使用, ce_flags
代表在定义 zend_class_entry 时候可用。
#define ZEND_ACC_STATIC 0x01 /* fn_flags, zend_property_info.flags */ #define ZEND_ACC_ABSTRACT 0x02 /* fn_flags */ #define ZEND_ACC_FINAL 0x04 /* fn_flags */ #define ZEND_ACC_IMPLEMENTED_ABSTRACT 0x08 /* fn_flags */ #define ZEND_ACC_IMPLICIT_ABSTRACT_CLASS 0x10 /* ce_flags */ #define ZEND_ACC_EXPLICIT_ABSTRACT_CLASS 0x20 /* ce_flags */ #define ZEND_ACC_FINAL_CLASS 0x40 /* ce_flags */ #define ZEND_ACC_INTERFACE 0x80 /* ce_flags */ #define ZEND_ACC_INTERACTIVE 0x10 /* fn_flags */ #define ZEND_ACC_PUBLIC 0x100 /* fn_flags, zend_property_info.flags */ #define ZEND_ACC_PROTECTED 0x200 /* fn_flags, zend_property_info.flags */ #define ZEND_ACC_PRIVATE 0x400 /* fn_flags, zend_property_info.flags */ #define ZEND_ACC_PPP_MASK (ZEND_ACC_PUBLIC | ZEND_ACC_PROTECTED | ZEND_ACC_PRIVATE) #define ZEND_ACC_CHANGED 0x800 /* fn_flags, zend_property_info.flags */ #define ZEND_ACC_IMPLICIT_PUBLIC 0x1000 /* zend_property_info.flags; unused (1) */ #define ZEND_ACC_CTOR 0x2000 /* fn_flags */ #define ZEND_ACC_DTOR 0x4000 /* fn_flags */ #define ZEND_ACC_CLONE 0x8000 /* fn_flags */ #define ZEND_ACC_ALLOW_STATIC 0x10000 /* fn_flags */ #define ZEND_ACC_SHADOW 0x20000 /* fn_flags */ #define ZEND_ACC_DEPRECATED 0x40000 /* fn_flags */ #define ZEND_ACC_CLOSURE 0x100000 /* fn_flags */ #define ZEND_ACC_CALL_VIA_HANDLER 0x200000 /* fn_flags */
ZEND_ACC_CTOR
与 ZEND_ACC_DTOR
是比较特殊的掩码标志,分别代表着构造函数与析构函数,不要将这两个标志位用在其它方法上面。其它的一些魔术方法,如 __get
、 __call
等大都需要 arginfo,有关它们的内容将在后续章节中描述。
为类定义常量
这个比较简单,只涉及到一组函数,可以查看 Zend/zend_API.h
:
ZEND_API int zend_declare_class_constant(zend_class_entry *ce, const char *name, size_t name_length, zval *value TSRMLS_DC); ZEND_API int zend_declare_class_constant_null(zend_class_entry *ce, const char *name, size_t name_length TSRMLS_DC); ZEND_API int zend_declare_class_constant_long(zend_class_entry *ce, const char *name, size_t name_length, long value TSRMLS_DC); ZEND_API int zend_declare_class_constant_bool(zend_class_entry *ce, const char *name, size_t name_length, zend_bool value TSRMLS_DC); ZEND_API int zend_declare_class_constant_double(zend_class_entry *ce, const char *name, size_t name_length, double value TSRMLS_DC); ZEND_API int zend_declare_class_constant_stringl(zend_class_entry *ce, const char *name, size_t name_length, const char *value, size_t value_length TSRMLS_DC); ZEND_API int zend_declare_class_constant_string(zend_class_entry *ce, const char *name, size_t name_length, const char *value TSRMLS_DC);
完整测试示例
下面是来演示一个比较完整的测试示例:
// 定义类myclass zend_class_entry *myclass_ce; // 定义public方法 ZEND_METHOD(myclass, public_method) { php_printf("我是public类型的方法\n"); } // 定义构造函数 ZEND_METHOD(myclass, __construct) { php_printf("我是__construct方法\n"); } // 定义static方法 ZEND_METHOD(myclass, static_method) { php_printf("我是static_method方法\n"); } PHP_METHOD(myclass, public_method); PHP_METHOD(myclass, __construct); PHP_METHOD(myclass, static_method); static zend_function_entry myclass_method[] = { ZEND_ME(myclass, public_method, NULL, ZEND_ACC_PUBLIC) ZEND_ME(myclass, __construct, NULL, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR) ZEND_ME(myclass, static_method, NULL, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC) {NULL, NULL, NULL} }; ZEND_MINIT_FUNCTION(academy_sample_minit) { academy_sample_descriptor = zend_register_list_destructors_ex(php_sample_descriptor_dtor, NULL, PHP_SAMPLE_DESCRIPTOR_RES_NAME, module_number); academy_sample_descriptor_persist = zend_register_list_destructors_ex(NULL, php_sample_descriptor_dtor_persistent, PHP_SAMPLE_DESCRIPTOR_RES_NAME, module_number); zend_class_entry ce; INIT_CLASS_ENTRY(ce, "myclass", myclass_method); myclass_ce = zend_register_internal_class(&ce TSRMLS_CC); // 定义类属性 zend_declare_property_null(myclass_ce, "public_var", strlen("public_var"), ZEND_ACC_PUBLIC TSRMLS_CC); // 定义类常量 zend_declare_class_constant_string(myclass_ce, "CONSTANT_VAR", strlen("CONSTANT_VAR"), "LaravelAcademy" TSRMLS_CC); return SUCCESS; }
重新编译扩展,编写测试代码如下:
<?php myclass::static_method(); var_dump(myclass::CONSTANT_VAR); $myclass = new myclass(); $myclass->public_method(); $myclass->public_var = 'laravelacademy.org'; var_dump($myclass->public_var);
该示例代码运行结果如下:

以上就是本文的全部内容,希望本文的内容对大家的学习或者工作能带来一定的帮助,也希望大家多多支持 码农网
猜你喜欢:- Mac内核扩展开发
- PHP内核介绍及扩展开发指南―类和对象
- [ PHP 内核与扩展开发系列] 函数的参数:arginfo 与类型绑定
- [ PHP 内核与扩展开发系列] PHP 中的资源类型:持久资源
- [ PHP 内核与扩展开发系列] Array 与 HashTable:数组与链表
- [ PHP 内核与扩展开发系列] 函数返回值:引用参数与函数的执行结果
本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们。