phpdefine常量详解

2. class A {
3. public function __toString() {
4. return 'bar';
5. }
6. }
7. $a = new A();
8. define('foo', $a);
9. echo foo;
10. // 输出bar

php中的define究竟是如何实现的：

3. ZEND_FUNCTION(define)

4. {
5. char *name;
6. int name_len;
7. zval *val;
8. zval *val_free = NULL;
9. zend_bool non_cs = 0;
10. int case_sensitive = CONST_CS;
11. zend_constant c;

12. // 接收3个参数，string，zval，bool

13. if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sz|b", &name, &name_len, &val, &non_cs) == FAILURE) {
14. return;
15. }

16. // 是否大小写敏感

17. if(non_cs) {
18. case_sensitive = 0;
19. }

20. // 如果define类常量,则报错

21. if (zend_memnstr(name, "::", sizeof("::") - 1, name + name_len)) {
22. zend_error(E_WARNING, "Class constants cannot be defined or redefined");
23. RETURN_FALSE;
24. }

25. // 获取真正的值，用val保存

26. repeat:
27. switch (Z_TYPE_P(val)) {
28. case IS_LONG:
29. case IS_DOUBLE:
30. case IS_STRING:
31. case IS_BOOL:
32. case IS_RESOURCE:
33. case IS_NULL:
34. break;
35. case IS_OBJECT:
36. if (!val_free) {
37. if (Z_OBJ_HT_P(val)->get) {
38. val_free = val = Z_OBJ_HT_P(val)->get(val TSRMLS_CC);
39. goto repeat;
40. } else if (Z_OBJ_HT_P(val)->cast_object) {
41. ALLOC_INIT_ZVAL(val_free);
42. if (Z_OBJ_HT_P(val)->cast_object(val, val_free, IS_STRING TSRMLS_CC) == SUCCESS) {
43. val = val_free;
44. break;
45. }
46. }
47. }
48. /* no break */
49. default:
50. zend_error(E_WARNING,"Constants may only evaluate to scalar values");
51. if (val_free) {
52. zval_ptr_dtor(&val_free);
53. }
54. RETURN_FALSE;
55. }
57. // 构建常量
58. c.value = *val;
59. zval_copy_ctor(&c.value);
60. if (val_free) {
61. zval_ptr_dtor(&val_free);
62. }
63. c.flags = case_sensitive; /* non persistent */ // 如果大小写不敏感，则为0，敏感则为1
64. c.name = zend_strndup(name, name_len);
65. c.name_len = name_len+1;
66. c.module_number = PHP_USER_CONSTANT; // 标注非内核常量，而是用户定义的常量
68. // 注册常量
69. if (zend_register_constant(&c TSRMLS_CC) == SUCCESS) {
70. RETURN_TRUE;
71. } else {
72. RETURN_FALSE;
73. }
74. }

注意以repeat开始的一段循环，还用到了goto语句T_T

这段代码的作用为： 对于int，float，string，bool，resource，null，则实际定义的常量时直接使用这些值 对于object，则需要将object转成上述6个类型之一（如果转型之后依然是object，则继续转型） 如何将object成6个类型之一呢？从代码上看有2种手段：

2. if (Z_OBJ_HT_P(val)->get) {
3. val_free = val = Z_OBJ_HT_P(val)->get(val TSRMLS_CC);
4. goto repeat;
5. }
6. // __toString()方法会在cast_object中被调用
7. else if (Z_OBJ_HT_P(val)->cast_object) {
8. ALLOC_INIT_ZVAL(val_free);
9. if (Z_OBJ_HT_P(val)->cast_object(val, val_free, IS_STRING TSRMLS_CC) == SUCCESS)
10. {
11. val = val_free;
12. break;
13. }
14. }

1，Z_OBJ_HT_P(val)->get ，宏展开之后为(*val).value.obj.handlers->get

2，Z_OBJ_HT_P(val)->cast_object，宏展开之后为(*val).value.obj.handlers->cast_object

handlers是一个包含很多函数指针的结构体，具体定义参见_zend_object_handlers 。该结构体中的函数指针均用于操作object，比如读取/修改对象属性、获取/调用对象方法等等...get和cast_object也是其中之一。

对于一般的对象，php提供了标准的cast_object函数zend_std_cast_object_tostring，代码位于php-src/zend/zend-object-handlers.c中：

3. ZEND_API int zend_std_cast_object_tostring(zval *readobj, zval *writeobj, int type TSRMLS_DC) /* {{{ */

4. {
5. zval *retval;
6. zend_class_entry *ce;

7. switch (type) {

8. case IS_STRING:
9. ce = Z_OBJCE_P(readobj);
11. // 如果用户的class中定义了__toString,则尝试调用
12. if (ce->__tostring &&
13. (zend_call_method_with_0_params(&readobj, ce, &ce->__tostring, "__tostring", &retval) || EG(exception))) {
14. ……
16. }
17. return FAILURE;
18. ……
19. }
20. return FAILURE;
21. }

从上述具体实现来看，默认的cast_object就是去寻找class中的__tostring方法然后调用...

回到刚开始的例子，define('foo', $a) ，由于$a是A的实例，并且class A中定义了__toString，因此实际上foo常量就等于toString的返回值bar。

ps：继续挖掘一点小细节.

1，define有返回值 通常我们定义常量直接写成：define('foo', 123); 不过从define的实现上来看，它是有返回值的。根据手册上的描述：

成功时返回 TRUE， 或者在失败时返回 FALSE。

什么情况下define会失败呢？ 举个例子：

3. define('PHP_INT_MAX', 1); // 返回FALSE

4. define('FOO', 1); // 返回TRUE

5. define('FOO', 2); // 返回FALSE

上面代码包含了两种情况，一是我们尝试重新定义php内核的预定义常量，比如PHP_INT_MAX，这显然会失败。第二种情况是我们曾经在代码的某个位置定义过了一个常量FOO，然后又在接下来的程序中再次定义它，这也会造成失败。因此，在编码时最好将所有需要定义的常量写在一起，以免造成name重复。

2，常量名没有限制 再次回顾一下define的实现，其中仅仅判断name是否为XXX::YYY这种形式。

换句话说，define几乎对其name不做任何要求，当然也不需要name是一个合法的php变量名。因此，我们可以让define的常量取一些稀奇古怪的名称。例如：

2. define('>_<', 123); // 返回TRUE
3. echo >_<; // syntax error

不过如果定义了这样的常量，是没法直接使用的，会报语法错误。正确的使用方法如下：

2. define('>_<', 123); // 返回TRUE
3. echo constant('>_<'); // 输出123