PHP内核介绍及扩展开发指南——Extensions 的编写（一）

Extensions 的编写
理解了这些运行机制以后，本章着手介绍Extensions 的编写，但凡写程序的人都知道hello world，那好，就从hello world开始。

1.1Hello World
这是摘自《PHP手册》的示例程序：



这段代码实现了一个简单的extension，首先它包含了“php.h”，这是所有extensions都需要包含的头文件，它定义、声明了我们可以访问的所有Zend数据结构、常量和API等。下面对剩余的步骤进行解释。

1.1.1 声明导出函数


ZEND_FUNCTION宏用于声明一个可在PHP代码中调用的函数，其参数即成为PHP函数名，因此，这一句声明了一个名为first_module的PHP函数，将其展开如下：


可见，ZEND_FUNCTION就是简单的声明了一个名为zif_ first_module的C函数，zif可能是”Zend Internal Function”的缩写。函数的原型满足Zend引擎对PHP函数的调用约定，关于其参数将在后面章节进行解释。

1.1.2 声明导出函数块

声明C函数后，Zend并不知道如何调用，我们需要使用如下的语句来完成C函数到PHP函数的映射：


这创建了一个zend_function_entry数组，zend_function_entry存储了关于如何调用该PHP函数的信息，通过它Zend引擎就能够理解和调用我们的函数。

其定义如下：


fname是PHP函数名，是PHP代码能够通过它来调用我们的函数；handler是指向我们在前面声明的C函数的函数指针。这两个参数已经足以完成从C函数到PHP函数的映射。剩余的参数用于告诉Zend该PHP函数对于函数参数的要求，arg_info是个数组，它的每一项都描述了对应下标的参数，num_args是参数的个数，具体将在后面的章节介绍。

我们可以手动填充一个zend_function_entry，但更好的办法是使用Zend提供的宏ZEND_FE，因为Zend并不保证这个结构以后不会变。ZEND_FE使用第一个参数作为PHP函数名，并且在添加了zif前缀后作为C函数名；第二个参数用于填充arg_info，通常使用NULL。上面的代码将得到这样一个zend_function_entry结构：{” first_module,”, zif_first_module, NULL, 0, 0}。当然，这并不是说PHP函数名必须和C函数名有什么关系，也可以通过宏ZEND_NAMED_FE来手动指定PHP函数名，不过这并不是个好主意。

我们必须为希望导出的每一个C函数都创建一个zend_function_entry结构，并将其放到一个数组中以备后用，数组最后一项的成员必须全部为NULL，这用于标记数组的结束。

1.1.3 填写模块信息

下一步需要将我们的模块介绍给Zend，主要包括我们的模块名和导出的函数，这通过填充一个zend_module_entry结构来完成。
zend_module_entry firstmod_module_entry =
{
  STANDARD_MODULE_HEADER,
  "First Module",
  firstmod_functions,
  NULL,
  NULL,
  NULL,
  NULL,
  NULL,
  NO_VERSION_YET,
  STANDARD_MODULE_PROPERTIES
};
STANDARD_MODULE_HEADER和STANDARD_MODULE_
PROPERTIES宏填充了该结构的首尾部分，具体填充了什么并不是我们需要关心的，并且为了兼容后续版本也最好不要手工修改。
第二、三项是模块名称和导出函数，名称可以任意填写，导出函数就是我们在前面准备好的zend_function_entry数组。
接下来的五个参数是函数指针，其用法在后面介绍，这里只用NULL填充。

下面的参数是一个C字符串，用于表示模块版本，如果没有则使用NO_VERSION_YET，其实就是NULL。
填写完毕后，需要把这个结构传给Zend引擎，这通过下面的语句完成：


宏开关用于判断是否是动态链接的，动态链接时才会执行下面的语句，本文仅介绍动态链接的模块，并不关心静态链接时如何与Zend交流信息，因此，可以认为条件总为真。
ZEND_GET_MODULE(firstmod)最后展开得到名为get_module的一个函数：


这个函数就是简单的返回我们填充的zend_module_entry结构，这里需要注意的是结构的名称必须是xxx_module_entry，xxx是传递给ZEND_GET_MODULE的参数。当Zend加载我们的模块时，它首先会解析并调用名为get_module的函数，这样就可以得到我们的zend_module_entry，于是，PHP代码就可以调用模块导出的函数了。

1.1.4 实现导出函数

代码最后一部分实现了我们导出的函数：


这里依然要用ZEND_FUNCTION来声明函数原型，函数体通过Zend API和宏，访问了函数参数并返回一个long值——这些都将在后面的章节进行详细介绍。

1.2使用参数
函数的一个重要部分就是访问参数，但由于extension的特殊性，我们无法像通常的函数那样来访问参数。
先来看导出C函数的原型：


ht是用户传入参数的数目，但一般不应直接读取，而是通过宏ZEND_NUM_ARGS()来获取，这通常用于判断用户是否传入了规定数目的参数。下面介绍如何在我们的C函数中访问这些参数。

1.2.1 标准方法

常用的方法是使用下面这个函数，其使用方法类似于scanf，采用格式化字符串和变长参数列表的方式：


num_args指出我希望获取的参数数目，通常使用ZEND_NUM_ARGS()，因为我们一般会先用ZEND_NUM_ARGS()判断用户是否传入了规定数目的参数。TSRMLS_DC宏用于线程安全，define和declare时必须这样填写，在调用时应该改用TSRMLS_CC。
type_spec是格式化字符串，其每个字符代表期望的当前参数的类型，之后应传递相应类型变量的指针来接收值，就像scanf那样，可用的字符如下：


这里面，string是个特例，它需要两个参数，分别获取字符串指针和长度，这是因为PHP没有采用C串，不能根据0来判断字符串结尾。下面是个示例程序：


由于PHP语法不能规定函数原型，因此用户可以传递任意类型的参数，对此，zend_parse_parameters自动进行了类型检查和转换：在内置标量类型，即long、double、boolean和string之间，Zend会自动进行类型转换，我们总能成功取得参数；resource和array则不进行转换，用户传入的参数必须具有指定类型，否则返回错误；zval作为通用结构，可以用于任何参数类型，Zend只需要简单的将其写入本地的接收变量。
除了类型格式符外，该函数还支持另外3个控制符：


最后，关于参数的数目也是有要求的。如果没有采用默认参数，即’|’格式符，则ZEND_NUM_ARGS()、num_args和格式串指出的参数数目这三者间必须完全匹配，否则zend_parse_parameters返回错误；如果使用了默认参数，则ZEND_NUM_ARGS()应和num_args相等，并且应该落在格式串指出的参数数目区间内。

童鞋们，未完待续哦~~