Implement DOMNode::getRootNode()

nielsdos · nielsdos · commit d17069e19193 · 2023-07-13T16:27:28.000+02:00
ref: https://dom.spec.whatwg.org/#dom-node-getrootnode Closes GH-11693.
diff --git a/NEWS b/NEWS
@@ -18,6 +18,7 @@ PHP                                                                        NEWS
 - DOM:
   . Added DOMNode::contains() and DOMNameSpaceNode::contains(). (nielsdos)
   . Added DOMElement::getAttributeNames(). (nielsdos)
+  . Added DOMNode::getRootNode(). (nielsdos)
 
 - Intl:
   . Fix memory leak in MessageFormatter::format() on failure. (Girgias)
diff --git a/UPGRADING b/UPGRADING
@@ -243,6 +243,9 @@ PHP 8.3 UPGRADE NOTES
 - DOM:
   . Added DOMNode::contains() and DOMNameSpaceNode::contains().
   . Added DOMElement::getAttributeNames().
+  . Added DOMNode::getRootNode(). The $options argument does nothing at the
+    moment because it only influences the shadow DOM, which we do not support
+    yet.
 
 - JSON:
   . Added json_validate(), which returns whether the json is valid for
diff --git a/ext/dom/node.c b/ext/dom/node.c
@@ -1818,4 +1818,30 @@ PHP_METHOD(DOMNode, contains)
 }
 /* }}} */
 
+/* {{{ URL: https://dom.spec.whatwg.org/#dom-node-getrootnode
+Since:
+*/
+PHP_METHOD(DOMNode, getRootNode)
+{
+	zval *id;
+	xmlNodePtr thisp;
+	dom_object *intern;
+	/* Unused now because we don't support the shadow DOM nodes. Options only influence shadow DOM nodes. */
+	zval *options = NULL;
+
+	if (zend_parse_parameters(ZEND_NUM_ARGS(), "|a!", &options) == FAILURE) {
+		RETURN_THROWS();
+	}
+
+	DOM_GET_THIS_OBJ(thisp, id, xmlNodePtr, intern);
+
+	while (thisp->parent) {
+		thisp = thisp->parent;
+	}
+
+	int ret;
+	DOM_RET_OBJ(thisp, &ret, intern);
+}
+/* }}} */
+
 #endif
diff --git a/ext/dom/php_dom.stub.php b/ext/dom/php_dom.stub.php
@@ -391,6 +391,8 @@ public function removeChild(DOMNode $child) {}
     public function replaceChild(DOMNode $node, DOMNode $child) {}
 
     public function contains(DOMNode|DOMNameSpaceNode|null $other): bool {}
+
+    public function getRootNode(?array $options = null): DOMNode {}
 }
 
 /** @not-serializable */
diff --git a/ext/dom/php_dom_arginfo.h b/ext/dom/php_dom_arginfo.h
diff --git a/ext/dom/tests/DOMNode_getRootNode.phpt b/ext/dom/tests/DOMNode_getRootNode.phpt
@@ -0,0 +1,32 @@
+--TEST--
+DOMNode::getRootNode()
+--EXTENSIONS--
+dom
+--FILE--
+<?php
+
+$dom = new DOMDocument();
+$dom->loadXML('<?xml version="1.0"?><html><body/></html>');
+
+var_dump($dom->documentElement->firstElementChild->getRootNode() === $dom);
+$p = $dom->createElement('p');
+var_dump($p->getRootNode() === $p);
+$dom->documentElement->appendChild($p);
+var_dump($p->getRootNode() === $dom);
+$dom->documentElement->remove();
+var_dump($p->getRootNode() === $p);
+
+$fragment = $dom->createDocumentFragment();
+var_dump($fragment->getRootNode() === $fragment);
+$div = $fragment->appendChild($dom->createElement('div'));
+$div->appendChild($p);
+var_dump($p->getRootNode() === $fragment);
+
+?>
+--EXPECT--
+bool(true)
+bool(true)
+bool(true)
+bool(true)
+bool(true)
+bool(true)

Original file line number	Diff line number	Diff line change
`@@ -391,6 +391,8 @@ public function removeChild(DOMNode $child) {}`
`391`	`391`	`public function replaceChild(DOMNode $node, DOMNode $child) {}`
`392`	`392`
`393`	`393`	`public function contains(DOMNode\|DOMNameSpaceNode\|null $other): bool {}`
	`394`	`+`
	`395`	`+ public function getRootNode(?array $options = null): DOMNode {}`
`394`	`396`	`}`
`395`	`397`
`396`	`398`	`/** @not-serializable */`