Fix #79065: DOM classes do not expose properties to Reflection

[cmb69]

We add a get_properties handler which complements the already
existing has_property and read_propertyhandlers.

[cmb69]

cc @beberlei

[beberlei]

@cmb69 awesome! i didn't know about this, weird that this hasn't come up earlier with reflection being used for IDE /static analysis stub generation regularly.

[kocsismate]

While we are at it, I was wonderingearlier if it would be possible (or worth) to also generate class, constant, and/or property registration code from our stubs?

UPDATE: these doesn't seem nicely doable :/ E.g. I now see that exposed constants are usually registered with a value of a built-in constant. Also, properties are given a handler whose name would be a bit weird to maintain in the stubs (?)

[cmb69]

For default properties which do not have special handling, it might be possible to generate zend_declare_property_*() calls. However, none of the DOM properties is a default property; they're all dynamic.

[cmb69]

Applied as 6bc8f7e. Thanks!

[nikic]

I've reverted this change, because it causes assertion failures in PhpUnit:

php: /home/nikic/php-7.4/Zend/zend_types.h:1039: zend_gc_delref: Assertion `p->refcount > 0' failed.
==25569== 
==25569== Process terminating with default action of signal 6 (SIGABRT)
==25569==    at 0xA21BE97: raise (raise.c:51)
==25569==    by 0xA21D800: abort (abort.c:79)
==25569==    by 0xA20D399: __assert_fail_base (assert.c:92)
==25569==    by 0xA20D411: __assert_fail (assert.c:101)
==25569==    by 0x93ED1E: zend_gc_delref (zend_types.h:1039)
==25569==    by 0x93EFC0: i_zval_ptr_dtor (zend_variables.h:43)
==25569==    by 0x93F1E2: zval_ptr_dtor (zend_variables.c:84)
==25569==    by 0x95869A: _zend_hash_add_or_update_i (zend_hash.c:757)
==25569==    by 0x958CE3: zend_hash_update (zend_hash.c:879)
==25569==    by 0x3F544D: dom_get_properties (php_dom.c:427)
==25569==    by 0x99526C: zend_std_get_gc (zend_object_handlers.c:123)
==25569==    by 0x97B8A5: gc_scan_black (zend_gc.c:708)

Generally, I would recommend against overloading get_properties, because it never ends well. We introduced get_properties_for in 7.4 to allow targeted overloading. Reflection support was omitted from that intentionally. (DOM properties are like __get, and get the same level of Reflection. This may change if we introduce first-class accessors.)

[cmb69]

Thanks @nikic, I was not really aware of that. I have re-opened https://bugs.php.net/79065, and changed it to documentation problem.

[sebastianbergmann]

I've reverted this change, because it causes assertion failures in PhpUnit:

This type of assertion failures. After reading the reverting commit's message I thought PHPUnit's assertions were failing :-)