Implement Element::closest()

Author: nielsdos

ext/dom/element.c

@@ -1760,4 +1760,20 @@ PHP_METHOD(DOM_Element, matches)
 	dom_element_matches(thisp, intern, return_value, selectors_str);
 }
 
+PHP_METHOD(DOM_Element, closest)
+{
+	zend_string *selectors_str;
+
+	ZEND_PARSE_PARAMETERS_START(1, 1)
+		Z_PARAM_STR(selectors_str)
+	ZEND_PARSE_PARAMETERS_END();
+
+	xmlNodePtr thisp;
+	dom_object *intern;
+	zval *id;
+	DOM_GET_THIS_OBJ(thisp, id, xmlNodePtr, intern);
+
+	dom_element_closest(thisp, intern, return_value, selectors_str);
+}
+
 #endif

ext/dom/parentnode/css_selectors.c

@@ -231,4 +231,33 @@ void dom_element_matches(xmlNodePtr thisp, dom_object *intern, zval *return_valu
 	}
 }
 
+/* https://dom.spec.whatwg.org/#dom-element-closest */
+void dom_element_closest(xmlNodePtr thisp, dom_object *intern, zval *return_value, zend_string *selectors_str)
+{
+	lxb_css_parser_t parser;
+	lxb_selectors_t selectors;
+
+	lxb_css_selector_list_t *list = php_dom_parse_selector(&parser, &selectors, selectors_str, LXB_SELECTORS_OPT_MATCH_FIRST);
+	if (UNEXPECTED(list == NULL)) {
+		RETURN_THROWS();
+	} else {
+		xmlNodePtr current = thisp;
+		while (current != NULL) {
+			dom_query_selector_matches_ctx ctx = { current, false };
+			lxb_status_t status = lxb_selectors_match_node(&selectors, current, list, php_dom_query_selector_find_matches_callback, &ctx);
+			status = php_dom_check_css_execution_status(status);
+			if (UNEXPECTED(status != LXB_STATUS_OK)) {
+				break;
+			}
+			if (ctx.result) {
+				DOM_RET_OBJ(current, intern);
+				break;
+			}
+			current = current->parent;
+		}
+	}
+
+	php_dom_selector_cleanup(&parser, &selectors, list);
+}
+
 #endif

ext/dom/php_dom.h

@@ -199,6 +199,7 @@ bool php_dom_pre_insert_is_parent_invalid(xmlNodePtr parent);
 void dom_parent_node_query_selector(xmlNodePtr thisp, dom_object *intern, zval *return_value, zend_string *selectors_str);
 void dom_parent_node_query_selector_all(xmlNodePtr thisp, dom_object *intern, zval *return_value, zend_string *selectors_str);
 void dom_element_matches(xmlNodePtr thisp, dom_object *intern, zval *return_value, zend_string *selectors_str);
+void dom_element_closest(xmlNodePtr thisp, dom_object *intern, zval *return_value, zend_string *selectors_str);
 
 /* nodemap and nodelist APIs */
 xmlNodePtr php_dom_named_node_map_get_named_item(dom_nnodemap_object *objmap, const zend_string *named, bool may_transform);

ext/dom/php_dom.stub.php

@@ -1379,6 +1379,7 @@ public function replaceChildren(Node|string ...$nodes): void {}
 
         public function querySelector(string $selectors): ?Element {}
         public function querySelectorAll(string $selectors): NodeList {}
+        public function closest(string $selectors): ?Element {}
         public function matches(string $selectors): bool {}
     }
 

ext/dom/php_dom_arginfo.h

@@ -0,0 +1,49 @@
+--TEST--
+Test DOM\Element::closest() method: legit cases
+--EXTENSIONS--
+dom
+--FILE--
+<?php
+
+$xml = <<<XML
+<root>
+  <a/>
+  <div class="foo" xml:id="div1">
+    <div xml:id="div2">
+      <div class="bar" xml:id="div3"/>
+    </div>
+  </div>
+</root>
+XML;
+
+$dom = DOM\XMLDocument::createFromString($xml);
+
+function test($el, $selector) {
+  echo "--- Selector: $selector ---\n";
+  var_dump($el->closest($selector)?->getAttribute('xml:id'));
+}
+
+test($dom->getElementById('div3'), 'div');
+test($dom->getElementById('div3'), '[class="foo"]');
+test($dom->getElementById('div3'), ':not(root)');
+test($dom->getElementById('div3'), ':not(div)');
+test($dom->getElementById('div3'), 'a');
+test($dom->getElementById('div3'), 'root :not(div[class])');
+test($dom->getElementById('div3'), 'root > :not(div[class])');
+
+?>
+--EXPECT--
+--- Selector: div ---
+string(4) "div3"
+--- Selector: [class="foo"] ---
+string(4) "div1"
+--- Selector: :not(root) ---
+string(4) "div3"
+--- Selector: :not(div) ---
+NULL
+--- Selector: a ---
+NULL
+--- Selector: root :not(div[class]) ---
+string(4) "div2"
+--- Selector: root > :not(div[class]) ---
+NULL

ext/dom/tests/modern/css_selectors/closest.phpt

@@ -0,0 +1,30 @@
+--TEST--
+Test DOM\Element::closest() method: invalid selector
+--EXTENSIONS--
+dom
+--FILE--
+<?php
+
+$html = <<<HTML
+<article>
+  <div id="div-01">
+    Here is div-01
+    <div id="div-02">
+      Here is div-02
+      <div id="div-03">Here is div-03</div>
+    </div>
+  </div>
+</article>
+HTML;
+
+$dom = DOM\XMLDocument::createFromString("<root/>");
+
+try {
+  var_dump($dom->documentElement->closest('@invalid'));
+} catch (DOMException $e) {
+  echo $e->getMessage();
+}
+
+?>
+--EXPECT--
+Invalid selector (Selectors. Unexpected token: @invalid)