From 262a68e2c2e751293ac125a4e20beb0e28640f47 Mon Sep 17 00:00:00 2001 From: Niels Dossche <7771979+nielsdos@users.noreply.github.com> Date: Thu, 13 Jul 2023 20:53:52 +0200 Subject: [PATCH] Implement DOMElement::id ref: https://dom.spec.whatwg.org/#dom-element-id --- ext/dom/dom_properties.h | 2 ++ ext/dom/element.c | 53 +++++++++++++++++++++++++------- ext/dom/php_dom.c | 1 + ext/dom/php_dom.stub.php | 2 ++ ext/dom/php_dom_arginfo.h | 8 ++++- ext/dom/tests/DOMElement_id.phpt | 51 ++++++++++++++++++++++++++++++ ext/dom/tests/bug69846.phpt | 4 ++- ext/dom/tests/bug80602_3.phpt | 8 +++-- 8 files changed, 114 insertions(+), 15 deletions(-) create mode 100644 ext/dom/tests/DOMElement_id.phpt diff --git a/ext/dom/dom_properties.h b/ext/dom/dom_properties.h index 147c38ea3339d..281a37197bb30 100644 --- a/ext/dom/dom_properties.h +++ b/ext/dom/dom_properties.h @@ -73,6 +73,8 @@ int dom_documenttype_internal_subset_read(dom_object *obj, zval *retval); int dom_element_tag_name_read(dom_object *obj, zval *retval); int dom_element_class_name_read(dom_object *obj, zval *retval); int dom_element_class_name_write(dom_object *obj, zval *newval); +int dom_element_id_read(dom_object *obj, zval *retval); +int dom_element_id_write(dom_object *obj, zval *newval); int dom_element_schema_type_info_read(dom_object *obj, zval *retval); /* entity properties */ diff --git a/ext/dom/element.c b/ext/dom/element.c index 2ca3ef2f06692..8772c97180b00 100644 --- a/ext/dom/element.c +++ b/ext/dom/element.c @@ -137,11 +137,7 @@ int dom_element_tag_name_read(dom_object *obj, zval *retval) /* }}} */ -/* {{{ className string -URL: https://dom.spec.whatwg.org/#dom-element-classname -Since: -*/ -int dom_element_class_name_read(dom_object *obj, zval *retval) +static int dom_element_reflected_attribute_read(dom_object *obj, zval *retval, const char *name) { xmlNodePtr nodep = dom_object_get_node(obj); @@ -150,7 +146,7 @@ int dom_element_class_name_read(dom_object *obj, zval *retval) return FAILURE; } - xmlChar *content = xmlGetNoNsProp(nodep, (const xmlChar *) "class"); + xmlChar *content = xmlGetNoNsProp(nodep, (const xmlChar *) name); if (content == NULL) { ZVAL_EMPTY_STRING(retval); return SUCCESS; @@ -162,26 +158,61 @@ int dom_element_class_name_read(dom_object *obj, zval *retval) return SUCCESS; } -int dom_element_class_name_write(dom_object *obj, zval *newval) +static xmlAttrPtr dom_element_reflected_attribute_write(dom_object *obj, zval *newval, const char *name) { xmlNode *nodep = dom_object_get_node(obj); if (nodep == NULL) { php_dom_throw_error(INVALID_STATE_ERR, 1); - return FAILURE; + return NULL; } if (dom_node_is_read_only(nodep) == SUCCESS) { php_dom_throw_error(NO_MODIFICATION_ALLOWED_ERR, dom_get_strict_error(obj->document)); - return FAILURE; + return NULL; } /* Typed property, so it is a string already */ ZEND_ASSERT(Z_TYPE_P(newval) == IS_STRING); - xmlSetProp(nodep, (const xmlChar *) "class", (const xmlChar *) Z_STRVAL_P(newval)); + return xmlSetProp(nodep, (const xmlChar *) name, (const xmlChar *) Z_STRVAL_P(newval)); +} - php_libxml_invalidate_node_list_cache_from_doc(nodep->doc); +/* {{{ className string +URL: https://dom.spec.whatwg.org/#dom-element-classname +Since: +*/ +int dom_element_class_name_read(dom_object *obj, zval *retval) +{ + return dom_element_reflected_attribute_read(obj, retval, "class"); +} +int dom_element_class_name_write(dom_object *obj, zval *newval) +{ + if (dom_element_reflected_attribute_write(obj, newval, "class")) { + return SUCCESS; + } + return FAILURE; +} +/* }}} */ + +/* {{{ id string +URL: https://dom.spec.whatwg.org/#dom-element-id +Since: +*/ +int dom_element_id_read(dom_object *obj, zval *retval) +{ + return dom_element_reflected_attribute_read(obj, retval, "id"); +} + +static void php_set_attribute_id(xmlAttrPtr attrp, bool is_id); + +int dom_element_id_write(dom_object *obj, zval *newval) +{ + xmlAttrPtr attr = dom_element_reflected_attribute_write(obj, newval, "id"); + if (!attr) { + return FAILURE; + } + php_set_attribute_id(attr, true); return SUCCESS; } /* }}} */ diff --git a/ext/dom/php_dom.c b/ext/dom/php_dom.c index 2684c00e98d9c..5d1849856dede 100644 --- a/ext/dom/php_dom.c +++ b/ext/dom/php_dom.c @@ -752,6 +752,7 @@ PHP_MINIT_FUNCTION(dom) zend_hash_init(&dom_element_prop_handlers, 0, NULL, dom_dtor_prop_handler, 1); dom_register_prop_handler(&dom_element_prop_handlers, "tagName", sizeof("tagName")-1, dom_element_tag_name_read, NULL); dom_register_prop_handler(&dom_element_prop_handlers, "className", sizeof("className")-1, dom_element_class_name_read, dom_element_class_name_write); + dom_register_prop_handler(&dom_element_prop_handlers, "id", sizeof("id")-1, dom_element_id_read, dom_element_id_write); dom_register_prop_handler(&dom_element_prop_handlers, "schemaTypeInfo", sizeof("schemaTypeInfo")-1, dom_element_schema_type_info_read, NULL); dom_register_prop_handler(&dom_element_prop_handlers, "firstElementChild", sizeof("firstElementChild")-1, dom_parent_node_first_element_child_read, NULL); dom_register_prop_handler(&dom_element_prop_handlers, "lastElementChild", sizeof("lastElementChild")-1, dom_parent_node_last_element_child_read, NULL); diff --git a/ext/dom/php_dom.stub.php b/ext/dom/php_dom.stub.php index 97ce8f487354c..3f10d8098a307 100644 --- a/ext/dom/php_dom.stub.php +++ b/ext/dom/php_dom.stub.php @@ -544,6 +544,8 @@ class DOMElement extends DOMNode implements DOMParentNode, DOMChildNode public string $className; + public string $id; + /** @readonly */ public mixed $schemaTypeInfo = null; diff --git a/ext/dom/php_dom_arginfo.h b/ext/dom/php_dom_arginfo.h index 9f39a731e292a..f348fdae0e464 100644 --- a/ext/dom/php_dom_arginfo.h +++ b/ext/dom/php_dom_arginfo.h @@ -1,5 +1,5 @@ /* This is a generated file, edit the .stub.php file instead. - * Stub hash: 91732c51635f43f016f4b531d9aa8e00312084ec */ + * Stub hash: 44fb8e555fcd54e4b40c1a998d338f5021cbc965 */ ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_dom_import_simplexml, 0, 1, DOMElement, 0) ZEND_ARG_TYPE_INFO(0, node, IS_OBJECT, 0) @@ -1380,6 +1380,12 @@ static zend_class_entry *register_class_DOMElement(zend_class_entry *class_entry zend_declare_typed_property(class_entry, property_className_name, &property_className_default_value, ZEND_ACC_PUBLIC, NULL, (zend_type) ZEND_TYPE_INIT_MASK(MAY_BE_STRING)); zend_string_release(property_className_name); + zval property_id_default_value; + ZVAL_UNDEF(&property_id_default_value); + zend_string *property_id_name = zend_string_init("id", sizeof("id") - 1, 1); + zend_declare_typed_property(class_entry, property_id_name, &property_id_default_value, ZEND_ACC_PUBLIC, NULL, (zend_type) ZEND_TYPE_INIT_MASK(MAY_BE_STRING)); + zend_string_release(property_id_name); + zval property_schemaTypeInfo_default_value; ZVAL_NULL(&property_schemaTypeInfo_default_value); zend_string *property_schemaTypeInfo_name = zend_string_init("schemaTypeInfo", sizeof("schemaTypeInfo") - 1, 1); diff --git a/ext/dom/tests/DOMElement_id.phpt b/ext/dom/tests/DOMElement_id.phpt new file mode 100644 index 0000000000000..b406e3b432317 --- /dev/null +++ b/ext/dom/tests/DOMElement_id.phpt @@ -0,0 +1,51 @@ +--TEST-- +DOMElement::id +--EXTENSIONS-- +dom +--FILE-- +loadXML('
'); +$div = $dom->documentElement->firstChild; + +var_dump($div->id); +$div->id = "hello & world<>"; +var_dump($div->id); +$div->id = ""; +var_dump($div->id); +$div->id = "é"; +var_dump($div->id); +$div->id = "\0"; +var_dump($div->id); +$div->id = 12345; +var_dump($div->id); +try { + $div->id = new MyStringable(); +} catch (Throwable $e) { + echo "Error: ", $e->getMessage(), "\n"; +} +var_dump($div->id); +echo $dom->saveXML(); + +var_dump($dom->getElementById("12345") === $div); + +?> +--EXPECT-- +string(0) "" +string(15) "hello & world<>" +string(0) "" +string(2) "é" +string(0) "" +string(5) "12345" +Error: foo +string(5) "12345" + +
+bool(true) diff --git a/ext/dom/tests/bug69846.phpt b/ext/dom/tests/bug69846.phpt index 24d7526a7962b..27c11199e7b05 100644 --- a/ext/dom/tests/bug69846.phpt +++ b/ext/dom/tests/bug69846.phpt @@ -78,13 +78,15 @@ object(DOMText)#%d (21) { string(3) " " } -object(DOMElement)#7 (24) { +object(DOMElement)#7 (25) { ["schemaTypeInfo"]=> NULL ["tagName"]=> string(5) "form1" ["className"]=> string(0) "" + ["id"]=> + string(0) "" ["firstElementChild"]=> string(22) "(object value omitted)" ["lastElementChild"]=> diff --git a/ext/dom/tests/bug80602_3.phpt b/ext/dom/tests/bug80602_3.phpt index 195952fdc7b32..0e1b2dc796bce 100644 --- a/ext/dom/tests/bug80602_3.phpt +++ b/ext/dom/tests/bug80602_3.phpt @@ -21,13 +21,15 @@ var_dump($target); ?> --EXPECTF-- barfoobaz -object(DOMElement)#3 (24) { +object(DOMElement)#3 (25) { ["schemaTypeInfo"]=> NULL ["tagName"]=> string(4) "last" ["className"]=> string(0) "" + ["id"]=> + string(0) "" ["firstElementChild"]=> NULL ["lastElementChild"]=> @@ -72,13 +74,15 @@ object(DOMElement)#3 (24) { string(0) "" } barfoobaz -object(DOMElement)#2 (24) { +object(DOMElement)#2 (25) { ["schemaTypeInfo"]=> NULL ["tagName"]=> string(4) "last" ["className"]=> string(0) "" + ["id"]=> + string(0) "" ["firstElementChild"]=> NULL ["lastElementChild"]=>