Skip to content

Commit 72e2e25

Browse files
nielsdosnielsdos
committed
Implement DOMElement::id
ref: https://dom.spec.whatwg.org/#dom-element-id Closes GH-11701.
1 parent e8f0bdc commit 72e2e25

File tree

10 files changed

+118
-18
lines changed

10 files changed

+118
-18
lines changed

‎NEWS‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ PHP NEWS
1919
. Added DOMNode::contains() and DOMNameSpaceNode::contains(). (nielsdos)
2020
. Added DOMElement::getAttributeNames(). (nielsdos)
2121
. Added DOMNode::getRootNode(). (nielsdos)
22-
. Added DOMElement::className. (nielsdos)
22+
. Added DOMElement::className and DOMElement::id. (nielsdos)
2323
. Added DOMParentNode::replaceChildren(). (nielsdos)
2424

2525
- Intl:

‎UPGRADING‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -252,8 +252,9 @@ PHP 8.3 UPGRADE NOTES
252252
. Added DOMNode::getRootNode(). The $options argument does nothing at the
253253
moment because it only influences the shadow DOM, which we do not support
254254
yet.
255-
. Added DOMElement::className. This is not binary-safe at the moment
256-
because of underlying limitations of libxml2.
255+
. Added DOMElement::className and DOMElement::id.
256+
This is not binary-safe at the moment because of underlying limitations of
257+
libxml2.
257258
. Added DOMParentNode::replaceChildren().
258259

259260
- JSON:

‎ext/dom/dom_properties.h‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ int dom_documenttype_internal_subset_read(dom_object *obj, zval *retval);
7373
int dom_element_tag_name_read(dom_object *obj, zval *retval);
7474
int dom_element_class_name_read(dom_object *obj, zval *retval);
7575
int dom_element_class_name_write(dom_object *obj, zval *newval);
76+
int dom_element_id_read(dom_object *obj, zval *retval);
77+
int dom_element_id_write(dom_object *obj, zval *newval);
7678
int dom_element_schema_type_info_read(dom_object *obj, zval *retval);
7779

7880
/* entity properties */

‎ext/dom/element.c‎

Lines changed: 42 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -137,11 +137,7 @@ int dom_element_tag_name_read(dom_object *obj, zval *retval)
137137

138138
/* }}} */
139139

140-
/* {{{ className string
141-
URL: https://dom.spec.whatwg.org/#dom-element-classname
142-
Since:
143-
*/
144-
int dom_element_class_name_read(dom_object *obj, zval *retval)
140+
static int dom_element_reflected_attribute_read(dom_object *obj, zval *retval, const char *name)
145141
{
146142
xmlNodePtr nodep = dom_object_get_node(obj);
147143

@@ -150,7 +146,7 @@ int dom_element_class_name_read(dom_object *obj, zval *retval)
150146
return FAILURE;
151147
}
152148

153-
xmlChar *content = xmlGetNoNsProp(nodep, (const xmlChar *) "class");
149+
xmlChar *content = xmlGetNoNsProp(nodep, (const xmlChar *) name);
154150
if (content == NULL) {
155151
ZVAL_EMPTY_STRING(retval);
156152
return SUCCESS;
@@ -162,26 +158,61 @@ int dom_element_class_name_read(dom_object *obj, zval *retval)
162158
return SUCCESS;
163159
}
164160

165-
int dom_element_class_name_write(dom_object *obj, zval *newval)
161+
static xmlAttrPtr dom_element_reflected_attribute_write(dom_object *obj, zval *newval, const char *name)
166162
{
167163
xmlNode *nodep = dom_object_get_node(obj);
168164

169165
if (nodep == NULL) {
170166
php_dom_throw_error(INVALID_STATE_ERR, 1);
171-
return FAILURE;
167+
return NULL;
172168
}
173169

174170
if (dom_node_is_read_only(nodep) == SUCCESS) {
175171
php_dom_throw_error(NO_MODIFICATION_ALLOWED_ERR, dom_get_strict_error(obj->document));
176-
return FAILURE;
172+
return NULL;
177173
}
178174

179175
/* Typed property, so it is a string already */
180176
ZEND_ASSERT(Z_TYPE_P(newval) == IS_STRING);
181-
xmlSetProp(nodep, (const xmlChar *) "class", (const xmlChar *) Z_STRVAL_P(newval));
177+
return xmlSetProp(nodep, (const xmlChar *) name, (const xmlChar *) Z_STRVAL_P(newval));
178+
}
182179

183-
php_libxml_invalidate_node_list_cache_from_doc(nodep->doc);
180+
/* {{{ className string
181+
URL: https://dom.spec.whatwg.org/#dom-element-classname
182+
Since:
183+
*/
184+
int dom_element_class_name_read(dom_object *obj, zval *retval)
185+
{
186+
return dom_element_reflected_attribute_read(obj, retval, "class");
187+
}
184188

189+
int dom_element_class_name_write(dom_object *obj, zval *newval)
190+
{
191+
if (dom_element_reflected_attribute_write(obj, newval, "class")) {
192+
return SUCCESS;
193+
}
194+
return FAILURE;
195+
}
196+
/* }}} */
197+
198+
/* {{{ id string
199+
URL: https://dom.spec.whatwg.org/#dom-element-id
200+
Since:
201+
*/
202+
int dom_element_id_read(dom_object *obj, zval *retval)
203+
{
204+
return dom_element_reflected_attribute_read(obj, retval, "id");
205+
}
206+
207+
static void php_set_attribute_id(xmlAttrPtr attrp, bool is_id);
208+
209+
int dom_element_id_write(dom_object *obj, zval *newval)
210+
{
211+
xmlAttrPtr attr = dom_element_reflected_attribute_write(obj, newval, "id");
212+
if (!attr) {
213+
return FAILURE;
214+
}
215+
php_set_attribute_id(attr, true);
185216
return SUCCESS;
186217
}
187218
/* }}} */

‎ext/dom/php_dom.c‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -752,6 +752,7 @@ PHP_MINIT_FUNCTION(dom)
752752
zend_hash_init(&dom_element_prop_handlers, 0, NULL, dom_dtor_prop_handler, 1);
753753
dom_register_prop_handler(&dom_element_prop_handlers, "tagName", sizeof("tagName")-1, dom_element_tag_name_read, NULL);
754754
dom_register_prop_handler(&dom_element_prop_handlers, "className", sizeof("className")-1, dom_element_class_name_read, dom_element_class_name_write);
755+
dom_register_prop_handler(&dom_element_prop_handlers, "id", sizeof("id")-1, dom_element_id_read, dom_element_id_write);
755756
dom_register_prop_handler(&dom_element_prop_handlers, "schemaTypeInfo", sizeof("schemaTypeInfo")-1, dom_element_schema_type_info_read, NULL);
756757
dom_register_prop_handler(&dom_element_prop_handlers, "firstElementChild", sizeof("firstElementChild")-1, dom_parent_node_first_element_child_read, NULL);
757758
dom_register_prop_handler(&dom_element_prop_handlers, "lastElementChild", sizeof("lastElementChild")-1, dom_parent_node_last_element_child_read, NULL);

‎ext/dom/php_dom.stub.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -550,6 +550,8 @@ class DOMElement extends DOMNode implements DOMParentNode, DOMChildNode
550550

551551
public string $className;
552552

553+
public string $id;
554+
553555
/** @readonly */
554556
public mixed $schemaTypeInfo = null;
555557

‎ext/dom/php_dom_arginfo.h‎

Lines changed: 7 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎ext/dom/tests/DOMElement_id.phpt‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
--TEST--
2+
DOMElement::id
3+
--EXTENSIONS--
4+
dom
5+
--FILE--
6+
<?php
7+
8+
class MyStringable {
9+
public function __toString(): string {
10+
throw new Exception("foo");
11+
}
12+
}
13+
14+
$dom = new DOMDocument();
15+
$dom->loadXML('<html><div/></html>');
16+
$div = $dom->documentElement->firstChild;
17+
18+
var_dump($div->id);
19+
$div->id = "hello & world<>";
20+
var_dump($div->id);
21+
$div->id = "";
22+
var_dump($div->id);
23+
$div->id = "é";
24+
var_dump($div->id);
25+
$div->id = "\0";
26+
var_dump($div->id);
27+
$div->id = 12345;
28+
var_dump($div->id);
29+
try {
30+
$div->id = new MyStringable();
31+
} catch (Throwable $e) {
32+
echo "Error: ", $e->getMessage(), "\n";
33+
}
34+
var_dump($div->id);
35+
echo $dom->saveXML();
36+
37+
var_dump($dom->getElementById("12345") === $div);
38+
39+
?>
40+
--EXPECT--
41+
string(0) ""
42+
string(15) "hello & world<>"
43+
string(0) ""
44+
string(2) "é"
45+
string(0) ""
46+
string(5) "12345"
47+
Error: foo
48+
string(5) "12345"
49+
<?xml version="1.0"?>
50+
<html><div id="12345"/></html>
51+
bool(true)

‎ext/dom/tests/bug69846.phpt‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,13 +78,15 @@ object(DOMText)#%d (21) {
7878
string(3) "
7979
"
8080
}
81-
object(DOMElement)#7 (24) {
81+
object(DOMElement)#7 (25) {
8282
["schemaTypeInfo"]=>
8383
NULL
8484
["tagName"]=>
8585
string(5) "form1"
8686
["className"]=>
8787
string(0) ""
88+
["id"]=>
89+
string(0) ""
8890
["firstElementChild"]=>
8991
string(22) "(object value omitted)"
9092
["lastElementChild"]=>

‎ext/dom/tests/bug80602_3.phpt‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,15 @@ var_dump($target);
2121
?>
2222
--EXPECTF--
2323
<a>barfoobaz<last/></a>
24-
object(DOMElement)#3 (24) {
24+
object(DOMElement)#3 (25) {
2525
["schemaTypeInfo"]=>
2626
NULL
2727
["tagName"]=>
2828
string(4) "last"
2929
["className"]=>
3030
string(0) ""
31+
["id"]=>
32+
string(0) ""
3133
["firstElementChild"]=>
3234
NULL
3335
["lastElementChild"]=>
@@ -72,13 +74,15 @@ object(DOMElement)#3 (24) {
7274
string(0) ""
7375
}
7476
<a><last/>barfoobaz</a>
75-
object(DOMElement)#2 (24) {
77+
object(DOMElement)#2 (25) {
7678
["schemaTypeInfo"]=>
7779
NULL
7880
["tagName"]=>
7981
string(4) "last"
8082
["className"]=>
8183
string(0) ""
84+
["id"]=>
85+
string(0) ""
8286
["firstElementChild"]=>
8387
NULL
8488
["lastElementChild"]=>

0 commit comments

Comments
 (0)