[通译][php扩展和嵌入式]第11章-php5对象

PHP_MINIT_FUNCTION(sample3)
{
    zend_class_entry ce;
    /* 注册接口 */
    INIT_CLASS_ENTRY(ce, "Sample3_Interface",
                        php_sample3_iface_methods);

    php_sample3_iface_entry =
                zend_register_internal_class(&ce TSRMLS_CC);
    php_sample3_iface_entry->ce_flags|= ZEND_ACC_INTERFACE;
    /* 注册实现接口的类 */
    INIT_CLASS_ENTRY(ce, PHP_SAMPLE3_SC_NAME,
                            php_sample3_sc_functions);
    php_sample3_sc_entry =
                zend_register_internal_class(&ce TSRMLS_CC);
    php_sample3_register_constants(php_sample3_sc_entry);
    /* 声明实现关系 */
    zend_class_implements(php_sample3_sc_entry TSRMLS_CC,
                1, php_sample3_iface_entry);
    return SUCCESS;
}

如果Sample3_SecondClass实现了其他接口, 比如ArrayAccess, 就需要将对应的类(zend_class_entry)作为附加参数增加到zend_class_implements()调用中, 并将现在传递为数字1的参数值相应的增大为2:

zend_class_implements(php_sample3_sc_entry TSRMLS_CC,
            2, php_sample3_iface_entry, php_other_interface_entry);

句柄

ZE2并没有把所有的对象实例看做是相同的, 它为每个对象实例关联了句柄表. 当在一个对象上执行特定的操作时, 引擎调用执行对象的句柄表中自定义的行为.

标准句柄

默认情况下, 每个对象都被赋予了std_object_handlers这个内建句柄表. std_object_handlers中对应的句柄方法以及它们的行为定义如下:

• void add_ref(zval *object TSRMLS_DC)

当对象值的refcount增加时被调用, 比如, 当一个对象变量赋值给新的变量时. add_ref和del_ref函数的默认行为都是调整内部对象存储的refcount.

• void del_ref(zval *object TSRMLS_DC)

和add_ref类似, 这个方法也在修改refcount时调用, 通常是在unset()对象变量时发生的.

• zend_object_value clone_obj(zval *object TSRMLS_DC)

用于利用已有的对象实例创建一个新的实例. 默认行为是创建一个新的对象实例, 将它和原来的句柄表关联, 拷贝属性表, 如果该对象的类定义了__clone()方法, 则调用它让新的对象执行一些附加的复制工作.

• zval *read_property(zval *obj, zval *prop, int type TSRMLS_DC)
• void write_property(zval *obj, zval *prop, zval *value TSRMLS_DC)

在用户空间尝试以$obj->prop方式访问, 去读写对象的属性时, read_property/write_property对应的被调用. 默认的处理是首先在标准属性表中查找属性. 如果属性没有定义, 则检查是否存在__get()或__set()魔术方法, 如果有则调用该方法.

• zval **get_property_ptr_ptr(zval *obj, zval *value TSRMLS_DC)

get_property_ptr_ptr()是read_property()的一个变种, 它的含义是允许调用作用域直接将当前的zval *替换为新的. 默认的行为是返回标准属性表中该属性的指针地址. 如果不存在, 并且没有__get()/__set()魔术方法, 则隐式创建并返回指针. 如果存在__get()或__set()方法, 则导致这个句柄失败, 使得引擎转而依靠单独的read_property和write_property调用.

• zval *read_dimension(zval *obj, zval *idx, int type TSRMLS_DC)
• void write_dimension(zval *obj, zval *idx, zval *value TSRMLS_DC)

read_dimension()和write_dimension()类似于对应的read_property()和write_property();  不过它们在使用$obj['idx']方式将对象作为数组访问时被触发. 如果对象的类没有实现ArrayAccess接口, 默认的行为是触发一个错误; 否则它就会调用魔术方法offsetget($idx)或offsetset($idx, $value).

• zval *get(zval *obj TSRMLS_DC)
• void set(zval *obj, zval *value TSRMLS_DC)

在设置或取回对象的值时, 则会在对象上调用get()或set()方法. 对象自身作为第一个参数被传递. 对于set, 新的值作为第二个参数传递; 实际上, 这些方法被用于算数运算中. 这些操作没有默认处理器.

• int has_property(zval *obj, zval *prop, int chk_type TSRMLS_DC)

当在一个对象属性上调用isset()时, 这个句柄被调用. 默认情况下标准的处理器会检查prop指定的属性名, 在php 5.1.0中如果没有找到这个属性, 并且定义了__isset()方法, 则会调用这个方法. chk_type参数的值如果是2则仅需要属性存在, 如果chk_type值为0, 则必须存在并且不能是IS_NULL的值, 如果chk_type值为1, 则属性必须存在并且必须是非FALSE的值. 注意: 在php 5.0.x中, chk_type的含义和has_dimension的chk_type一致.

• int has_dimension(zval *obj, zval *idx, int chk_type TSRMLS_DC)

当将对象看做数组调用isset()时(比如isset($obj['idx'])), 使用这个处理器. 默认的标准处理器会检查对象是否实现了ArrayAccess接口, 如果实现了, 则调用offsetexists($idx)方法. 如果没有找到(指调用offsetexists()), 则和没有实现offsetexists()方法一样, 返回0. 否则, 如果chk_type为0, 直接返回true(1). chk_type为1标识它必须调用对象的offsetget($idx)方法并测试返回值, 检查值是非FALSE才返回TRUE(1).

• void unset_property(zval *obj, zval *prop TSRMLS_DC)
• void unset_dimension(zval *obj, zval *idx TSRMLS_DC)

这两个方法在尝试卸载对象属性时(或将对象以数组方式应用调用unset()时)被调用. unset_property()处理器要么从标准属性表删除属性(如果存在), 要么就尝试调用实现的__unset($prop)方法(php 5.1.0中), unset_dimension()则在类实现了ArrayAccess时, 调用offsetunset($idx)方法.

• HashTable *get_properties(zval *obj TSRMLS_DC)

当内部函数使用Z_OBJPROP()宏从标准属性表中读取属性时, 实际上是调用了这个处理器. php对象的默认处理器是解开并返回Z_OBJ_P(object)->properties, 它是真正的标准属性表.

• union _zend_function *get_method(zval **obj_ptr char *method_name, int methodname_len TSRMLS_DC)

这个处理器在解析类的function_table中的对象方法时被调用. 如果在主的function_table中不存在方法, 则默认的处理器返回一个指向对对象的__call($name, $args)方法包装的zend_function *指针.

• int call_method(char *method, INTERNAL_FUNCTION_PARAMETERS)

定义为ZEND_OVERLOADED_FUNCTION类型的函数将以call_method处理器的方式执行. 默认情况下, 这个处理器是未定义的.

• union _zend_function *get_constructor(zval *obj TSRMLS_DC)

类似于get_method()处理器, 这个处理器返回一个对对应对象方法的引用. 类的zend_class_entry中构造器是特殊方式存储的, 这使得它比较特殊. 对这个方法的重写非常少见.

• zend_class_entry *get_class_entry(zval *obj TSRMLS_DC)

和get_constructor()类似, 这个处理器也很少被重写. 它的目的是将一个对象实例映射回它原来的类定义.

• int get_class_name(zval *object, char **name zend_uint *len, int parent TSRMLS_DC)

get_class_entry()就是get_class_name()其中的一步, 在得到对象的zend_object后, 它将对象的类名或它的父类名(这依赖于参数parent的值)复制一份返回. 返回的类名拷贝必须使用非持久化存储(emalloc()).

• int compare_objects(zval *obj1, zval *obj2 TSRMLS_DC)

当比较操作符(比如: ==, !=, <=, <, >, >=)用在两个对象上时, 在操作数(参与比较的两个对象)上调用compare_objects()就是这个工作的第一部分. 它的返回值通常是1, 0, -1, 分别代表大于, 等于, 小于.默认 情况下, 对象是基于它们的标准属性表比较的, 使用的比较规则和第8章"在数组和HashTable上工作"中学习的数组比较规则一样.

• int cast_object(zval *src, zval *dst, int type, int should_free TSRMLS_DC)

当尝试将对象转换为其他数据类型时, 会触发这个处理器. 如果将should_free设置为非0值, zval_dtor()将会在dst上调用, 首先释放内部的资源. 总之, 处理器应该尝试将src中的对象表示为dst给出的zval *的类型中. 这个处理器默认是未定义的, 但当有它的时候, 应该返回SUCCESS或FAILURE.

• int count_elements(zval *obj, long *count TSRMLS_DC)

实现了数组访问的对象应该定义这个处理器, 它将设置当前的元素数量到count中并返回SUCCESS. 如果当前实例没有实现数组访问, 则它应该返回FAILURE, 以使引擎回头去检查标准属性表.

译注: 上面的句柄表和译者使用的php-5.4.9中已经不完全一致, 读者在学习这一部分的时候, 可以参考Zend/zend_object_handlers.c中最下面的标准处理器句柄表.

魔术方法第二部分

使用前面看到的对象句柄表的自定义版本, 可以让内部类提供与在用户空间基于对象或类的__xxx()魔术方法相比, 相同或更多的能力.将这些自定义的句柄设置到对象实例上首先要求创建一个新的句柄表. 因为你通常不会覆写所有的句柄, 因此首先将标准句柄表拷贝到你的自定义句柄表中再去覆写你想要修改的句柄就很有意义了:

static zend_object_handlers php_sample3_obj_handlers;
int php_sample3_has_dimension(zval *obj, zval *idx,
                        int chk_type TSRMLS_DC)
{
    /* 仅在php版本>=1.0时使用 */
    if (chk_type == 0) {
       /* 重新映射chk_type的值 */
       chk_type = 2;
    }
    /* 当chk_type值为1时保持不变. 接着使用标准的hash_property方法执行逻辑 */
    return php_sample3_obj_handlers.has_property(obj,
                            idx, chk_type TSRMLS_CC);
}
PHP_MINIT_FUNCTION(sample3)
{
    zend_class_entry ce;
    zend_object_handlers *h = &php_sample3_obj_handlers;


    /* 注册接口 */
    INIT_CLASS_ENTRY(ce, "Sample3_Interface",
                        php_sample3_iface_methods);
    php_sample3_iface_entry =
                zend_register_internal_class(&ce TSRMLS_CC);
    php_sample3_iface_entry->ce_flags = ZEND_ACC_INTERFACE;
    /* 注册SecondClass类 */
    INIT_CLASS_ENTRY(ce, PHP_SAMPLE3_SC_NAME,
                            php_sample3_sc_functions);
    php_sample3_sc_entry =
                zend_register_internal_class(&ce TSRMLS_CC);
    php_sample3_register_constants(php_sample3_sc_entry);


    /* 实现AbstractClass接口 */
    zend_class_implements(php_sample3_sc_entry TSRMLS_CC,
                1, php_sample3_iface_entry);


    /* 创建自定义句柄表 */
    php_sample3_obj_handlers = *zend_get_std_object_handlers();


    /* 这个句柄表的目的是让$obj['foo']的行为等价于$obj->foo */
    h->read_dimension = h->read_property;
    h->write_dimension = h->write_property;
    h->unset_dimension = h->unset_property;
#if PHP_MAJOR_VERSION > 5 || \
            (PHP_MAJOR_VERSION == 5 && PHP_MINOR_VERSION > 0)
    /* php-5.1.0中, has_property和has_dimension的chk_type含义不同, 为使它们行为一致, 自己包装一个函数 */
    h->has_dimension = php_sample3_has_dimension;

#else
    /* php 5.0.x的has_property和has_dimension行为一致 */
    h->has_dimension = h->has_property;
#endif


    return SUCCESS;
}

要将这个句柄表应用到对象上, 你有两种选择. 最简单也是最具代表性的就是实现一个构造器方法, 并在其中重新赋值变量的句柄表.

PHP_METHOD(Sample3_SecondClass,__construct)
{
    zval *objptr = getThis();


    if (!objptr) {
        php_error_docref(NULL TSRMLS_CC, E_WARNING,
                    "Constructor called statically!");
        RETURN_FALSE;
    }
    /* 执行正常的构造器任务... */
    /* 覆写句柄表 */
    Z_OBJ_HT_P(objptr) = &php_sample3_obj_handlers;
}

当构造器返回时, 对象就有了新的句柄表以及对应的自定义行为. 还有一种更加受欢迎的方法是覆写类的对象创建函数.

zend_object_value php_sample3_sc_create(zend_class_entry *ce
                                        TSRMLS_DC)
{
    zend_object *object;
    zend_object_value retval;


    /* 返回Zend创建的对象 */
    retval = zend_objects_new(&object, ce TSRMLS_CC);
    /* 覆写create_object时, 属性表必须手动初始化 */
    ALLOC_HASHTABLE(object->properties);
    zend_hash_init(object->properties, 0, NULL,
                                    ZVAL_PTR_DTOR, 0);
    /* 覆写默认句柄表 */
    retval.handlers = &php_sample3_obj_handlers;
    /* 这里可能会执行其他对象初始化工作 */
    return retval;
}

INIT_CLASS_ENTRY(ce, PHP_SAMPLE3_SC_NAME,
                        php_sample3_sc_functions);
php_sample3_sc_entry =
            zend_register_internal_class(&ce TSRMLS_CC);
php_sample3_sc_entry->create_object= php_sample3_sc_create;
php_sample3_register_constants(php_sample3_sc_entry);
zend_class_implements(php_sample3_sc_entry TSRMLS_CC,
            1, php_sample3_iface_entry);