php的扩展和嵌入--c++类的扩展开发

 1 PHP_ARG_ENABLE(vehicles,  2     [Whether to enable the "vehicles" extension],  3     [  --enable-vehicles      Enable "vehicles" extension support])  4   5 if test $PHP_VEHICLES != "no"; then  6     PHP_REQUIRE_CXX()  7     PHP_SUBST(VEHICLES_SHARED_LIBADD)  8     PHP_ADD_LIBRARY(stdc++, 1, VEHICLES_SHARED_LIBADD)  9     PHP_NEW_EXTENSION(vehicles, vehicles.cc car.cc, $ext_shared)10 fi

#ifndef VEHICLES_CAR_H  2 #define VEHICLES_CAR_H  3   4 // A very simple car class  5 class Car {  6 public:  7     Car(int maxGear);  8     void shift(int gear);  9     void accelerate();10     void brake();11     int getCurrentSpeed();12     int getCurrentGear();13 private:14     int maxGear;15     int currentGear;16     int speed;17 };18 19 #endif /* VEHICLES_CAR_H */ 

2 #include "car.h"  3 Car::Car(int maxGear) {  4     this->maxGear = maxGear;  5     this->currentGear = 1;  6     this->speed = 0;  7 }  9 void Car::shift(int gear) {10     if (gear < 1 || gear > maxGear) {11         return;12     }13     currentGear = gear;14 }16 void Car::accelerate() {17     speed += (5 * this->getCurrentGear());18 }20 void Car::brake() {21     speed -= (5 * this->getCurrentGear());22 }24 int Car::getCurrentSpeed() {25     return speed;26 }

1 #ifndef PHP_VEHICLES_H  2 #define PHP_VEHICLES_H  4 #define PHP_VEHICLES_EXTNAME  "vehicles"  5 #define PHP_VEHICLES_EXTVER   "0.1"  7 #ifdef HAVE_CONFIG_H  8 #include "config.h"  9 #endif10 11 extern "C" {12 #include "php.h"13 }14 15 extern zend_module_entry vehicles_module_entry;16 #define phpext_vehicles_ptr &vehicles_module_entry;17 18 #endif /* PHP_VEHICLES_H */

1 #include "php_vehicles.h"2 PHP_MINIT_FUNCTION(vehicles)3 {4    return SUCCESS;5 }6 zend_module_entry vehicles_module_entry = {7 #if ZEND_MODULE_API_NO >= 200109018    STANDARD_MODULE_HEADER,9 #endif10    PHP_VEHICLES_EXTNAME,11    NULL,                  /* Functions */12    PHP_MINIT(vehicles),13    NULL,                  /* MSHUTDOWN */14    NULL,                  /* RINIT */15    NULL,                  /* RSHUTDOWN */16    NULL,                  /* MINFO */17 #if ZEND_MODULE_API_NO >= 2001090118    PHP_VEHICLES_EXTVER,19 #endif20    STANDARD_MODULE_PROPERTIES21 };22 #ifdef COMPILE_DL_VEHICLES23 extern "C" {24 ZEND_GET_MODULE(vehicles)25}26 #endif

• phpize
• ./configure --enable-vehicles
• make
• sudo make install
• 在php.ini中加入extension=vehicles.so(只需要一次)
• 重启apache,如果是服务的话 sudo /etc/init.d/httpd restart
• 然后在info.php中查看是否已经有了vehicles这一项扩展.
• 如果觉得每次打都很麻烦,也可以简单的写一个shell脚本来完成这些工作. 在完成了基本的初始化之后,就要开始考虑php用户空间与我们定义的C++类之间的联系了.这部分代码是为了把类中的函数都暴露给php的用户空间脚本,
  • 首先需要定义一个名字同样是Car的php类,
  • 然后还要定义一组zend_function_entry表,用来说明这个类中有哪些方法想要引入到php用户空间中.
  • 需要注意的是,在php用户空间中的方法不一定要跟c++类中的方法同名,你同时还可以根据自己的需要增加或删减c++类中的方法.这点非常的自由.
    
    按照如下的代码更改vehicles.h

    1  #include "php_vehicles.h"2  zend_class_entry *car_ce;3  PHP_METHOD(Car, __construct){}5  PHP_METHOD(Car, shift) {}7  PHP_METHOD(Car, accelerate) {}9  PHP_METHOD(Car, brake) {}11  PHP_METHOD(Car, getCurrentSpeed){}13  PHP_METHOD(Car, getCurrentGear){}15  zend_function_entry car_methods[] = {16    PHP_ME(Car,  __construct,     NULL, ZEND_ACC_PUBLIC | ZEND_ACC_CTOR)17    PHP_ME(Car,  shift,           NULL, ZEND_ACC_PUBLIC)18    PHP_ME(Car,  accelerate,      NULL, ZEND_ACC_PUBLIC)19    PHP_ME(Car,  brake,           NULL, ZEND_ACC_PUBLIC)20    PHP_ME(Car,  getCurrentSpeed, NULL, ZEND_ACC_PUBLIC)21    PHP_ME(Car,  getCurrentGear,  NULL, ZEND_ACC_PUBLIC)22    {NULL, NULL, NULL}23  };24  PHP_MINIT_FUNCTION(vehicles)25  {26    zend_class_entry ce;27    INIT_CLASS_ENTRY(ce, "Car", car_methods);28    car_ce = zend_register_internal_class(&ce TSRMLS_CC);29    return SUCCESS;30  }31  zend_module_entry vehicles_module_entry = {32  #if ZEND_MODULE_API_NO >= 2001090133     STANDARD_MODULE_HEADER,34  #endif35    PHP_VEHICLES_EXTNAME,36    NULL,        /* Functions */37    PHP_MINIT(vehicles),        /* MINIT */38    NULL,        /* MSHUTDOWN */39    NULL,        /* RINIT */40    NULL,        /* RSHUTDOWN */41    NULL,        /* MINFO */42  #if ZEND_MODULE_API_NO >= 2001090143    PHP_VEHICLES_EXTVER,44  #endif45    STANDARD_MODULE_PROPERTIES46 };47  #ifdef COMPILE_DL_VEHICLES48  extern "C" {49  ZEND_GET_MODULE(vehicles)50  }51  #endif

    
    
    首先是在第二行定义了一个zend_class_entry,这个入口会在MINIT的时候进行相应的初始化.3~13行给出了C++类的成员函数所转换成的php方法的版本,之后会添加上相应的实现.15~23行定义了函数入口zend_function_entry,php方法定义的地方.这里也可以声明一组自己定义的别名.（如何定义，怎么体现？）24~30给出的是新的模块初始化MINIT函数:
    • INIT_CLASS_ENTRY函数把类的入口和之前在zend_function_entry中类的方法联系了起来，属于类的初始化
    • 而car_ce = zend_register_internal_class(&ce TSRMLS_CC) ，注册类，把类加入到Class Table中，31～51行跟之前的模块入口没什么差别。
      
      现在已经声明了一组跟C++类成员函数同名的php函数，再接下来需要做的就是把两者联系起来：每个C++的类实例都必须对应一个php的类实例，一种实现的方法是使用一个结构来追踪现有的C++和php的类实例。而为了做到这一点，就需要写出自己的对象处理器，在php5中，一个对象就是由一个句柄（使得Zend引擎能够定位你的类的id）、一个函数表、和一组处理器组成的。在对象的声明周期的不同阶段都可以重写处理器以实现不同的功能。所以在之前的代码基础上，先增加一个对象处理器：
      

      1  #include "car.h"2  zend_object_handlers car_object_handlers;3  struct car_object {4     zend_object std;5     Car *car;6  };

      
      
      
      这个car_object结构会被用来追踪C++的实例，然后与zend_object联系起来。在PHP_METHOD的声明之前，需要加上下面两个方法：
      

      1  void car_free_storage(void *object TSRMLS_DC)2  {3    car_object *obj = (car_object *)object;4    delete obj->car; 5    zend_hash_destroy(obj->std.properties);6    FREE_HASHTABLE(obj->std.properties);7    efree(obj);8  }9  zend_object_value car_create_handler(zend_class_entry *type TSRMLS_DC)10  {11    zval *tmp;12    zend_object_value retval;13    car_object *obj = (car_object *)emalloc(sizeof(car_object));14    memset(obj, 0, sizeof(car_object));15    obj->std.ce = type;16    ALLOC_HASHTABLE(obj->std.properties);17    zend_hash_init(obj->std.properties, 0, NULL, ZVAL_PTR_DTOR, 0);18    zend_hash_copy(obj->std.properties, &type->default_properties,19        (copy_ctor_func_t)zval_add_ref, (void *)&tmp, sizeof(zval *));20    retval.handle = zend_objects_store_put(obj, NULL,21        car_free_storage, NULL TSRMLS_CC);22    retval.handlers = &car_object_handlers;23    return retval;24 }

      
      
      而后需要对模块初始化函数MINIT进行如下修改：
      

      25 PHP_MINIT_FUNCTION(vehicles)26 {27    zend_class_entry ce;28    INIT_CLASS_ENTRY(ce, "Car", car_methods);29    car_ce = zend_register_internal_class(&ce TSRMLS_CC);30    car_ce->create_object = car_create_handler;31    memcpy(&car_object_handlers,32        zend_get_std_object_handlers(), sizeof(zend_object_handlers));33    car_object_handlers.clone_obj = NULL;34    return SUCCESS;35} 

      
      
      这里我们看到第30行，首先调用car_create_handler创建一个create_object处理器。在调用car_create_handler的时候注意一个大坑那就是第18行这里$type->default_properties，php的新版本中这里是properties_info，这个编译错误在对比源码了之后才知道怎么改。
      • 13～15行给一个car_object申请了空间，并完成了初始化。同时把obj对应的zend_class_object和输入的type()进行了连接，也就是把MINIT中初始化的zend对象绑定在了car_object这个结构中。
      • 在完成了绑定之后，16～19继续进行拷贝过程。
      • 20~21行把obj加入到了zend的对象中，并用函数指针的方式定义了销毁时候的函数car_free_storage，同时产生了一个对象obj的句柄
      • 第31行则给处理器handlers了相应的zend_object_handlers的值（这里还很不明晰）
        
        
        现在在php的类构造函数中，就要读取用户的参数，并且把它们传递给C++的构造函数。一旦C++的类实例被创建了，那就可以从zend对象store中抓取car_object指针，然后设定结构体中的car值。这样的话，就把zend对象实例和C++的Car实例绑定了起来。
        

        1  PHP_METHOD(Car, __construct)2  {3     long maxGear;4    Car *car = NULL;5    zval *object = getThis();6    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &maxGear) == FAILURE) {7        RETURN_NULL();8    }9    car = new Car(maxGear);10    car_object *obj = (car_object *)zend_object_store_get_object(object TSRMLS_CC);11    obj->car = car;12  }

        
        
        通过调用zend_object_store_get_object函数就能够获得C++类的一个实例。而下面的两个函数也是同样的道理：
        

        PHP_METHOD(accelerate){    Car *car;    car_object *obj = (car_object *)zend_object_store_get_object(        getThis() TSRMLS_CC);    car = obj->car;    if (car != NULL) {        car->accelerate();    }}PHP_METHOD(getCurrentSpeed){    Car *car;    car_object *obj = (car_object *)zend_object_store_get_object(        getThis() TSRMLS_CC);    car = obj->car;    if (car != NULL) {        RETURN_LONG(car->getCurrentSpeed());    }    RETURN_NULL();}

        
        
        
        好了，到现在为止基本上整个框架就搭好了。 不要忘了重新配置编译一下，然后用如下的php代码就可以进行测试了：

        / create a 5 gear car$car = new Car(5);print $car->getCurrentSpeed();  // prints '0'$car->accelerate();print $car->getCurrentSpeed(); // prints '5'If you can run this script, congratulations, you’ve just created a PHP extension that wraps a C++ class.
        
        
        

        如果说输出跟标识的一致的话，那么整个过程就成功了，恭喜！