Implement HTMLElement class

Author: nielsdos

ext/dom/dom_ce.h

@@ -44,6 +44,7 @@ extern PHP_DOM_EXPORT zend_class_entry *dom_attr_class_entry;
 extern PHP_DOM_EXPORT zend_class_entry *dom_modern_attr_class_entry;
 extern PHP_DOM_EXPORT zend_class_entry *dom_element_class_entry;
 extern PHP_DOM_EXPORT zend_class_entry *dom_modern_element_class_entry;
+extern PHP_DOM_EXPORT zend_class_entry *dom_html_element_class_entry;
 extern PHP_DOM_EXPORT zend_class_entry *dom_text_class_entry;
 extern PHP_DOM_EXPORT zend_class_entry *dom_modern_text_class_entry;
 extern PHP_DOM_EXPORT zend_class_entry *dom_comment_class_entry;

ext/dom/html_document.c

@@ -1423,7 +1423,8 @@ zend_result dom_html_document_body_write(dom_object *obj, zval *newval)
 		dom_object *newval_intern = Z_DOMOBJ_P(newval);
 		if (newval_intern->ptr != NULL) {
 			xmlNodePtr newval_node = ((php_libxml_node_ptr *) newval_intern->ptr)->node;
-			if (php_dom_ns_is_fast(newval_node, php_dom_ns_is_html_magic_token) && dom_accept_body_name(newval_node->name)) {
+			/* Note: because this property has type HTMLElement, we know the namespace is correct. */
+			if (dom_accept_body_name(newval_node->name)) {
 				/* 2. If the new value is the same as the body element, return. */
 				const xmlNode *current_body_element = dom_html_document_element_read_raw(docp, dom_accept_body_name);
 				if (current_body_element == newval_node) {

ext/dom/internal_helpers.h

@@ -47,7 +47,6 @@ static zend_always_inline zend_class_entry *dom_get_dtd_namednodemap_ce(bool mod
 
 DOM_DEF_GET_CE_FUNC(node)
 DOM_DEF_GET_CE_FUNC(documenttype)
-DOM_DEF_GET_CE_FUNC(element)
 DOM_DEF_GET_CE_FUNC(attr)
 DOM_DEF_GET_CE_FUNC(entity)
 DOM_DEF_GET_CE_FUNC(entityreference)

ext/dom/php_dom.c

@@ -62,6 +62,7 @@ PHP_DOM_EXPORT zend_class_entry *dom_attr_class_entry;
 PHP_DOM_EXPORT zend_class_entry *dom_modern_attr_class_entry;
 PHP_DOM_EXPORT zend_class_entry *dom_element_class_entry;
 PHP_DOM_EXPORT zend_class_entry *dom_modern_element_class_entry;
+PHP_DOM_EXPORT zend_class_entry *dom_html_element_class_entry;
 PHP_DOM_EXPORT zend_class_entry *dom_text_class_entry;
 PHP_DOM_EXPORT zend_class_entry *dom_modern_text_class_entry;
 PHP_DOM_EXPORT zend_class_entry *dom_comment_class_entry;
@@ -1036,6 +1037,11 @@ PHP_MINIT_FUNCTION(dom)
 	DOM_OVERWRITE_PROP_HANDLER(&dom_modern_element_prop_handlers, "textContent", dom_node_text_content_read, dom_node_text_content_write);
 	zend_hash_add_new_ptr(&classes, dom_modern_element_class_entry->name, &dom_modern_element_prop_handlers);
 
+	dom_html_element_class_entry = register_class_Dom_HTMLElement(dom_modern_element_class_entry);
+	dom_html_element_class_entry->create_object = dom_objects_new;
+	dom_html_element_class_entry->default_object_handlers = &dom_object_handlers;
+	zend_hash_add_new_ptr(&classes, dom_html_element_class_entry->name, &dom_modern_element_prop_handlers);
+
 	dom_text_class_entry = register_class_DOMText(dom_characterdata_class_entry);
 	dom_text_class_entry->create_object = dom_objects_new;
 	dom_text_class_entry->default_object_handlers = &dom_object_handlers;
@@ -1535,6 +1541,19 @@ void php_dom_create_iterator(zval *return_value, dom_iterator_type iterator_type
 }
 /* }}} */
 
+static zend_always_inline zend_class_entry *dom_get_element_ce(const xmlNode *node, bool modern)
+{
+	if (modern) {
+		if (php_dom_ns_is_fast(node, php_dom_ns_is_html_magic_token)) {
+			return dom_html_element_class_entry;
+		} else {
+			return dom_modern_element_class_entry;
+		}
+	} else {
+		return dom_element_class_entry;
+	}
+}
+
 /* {{{ php_dom_create_object */
 PHP_DOM_EXPORT bool php_dom_create_object(xmlNodePtr obj, zval *return_value, dom_object *domobj)
 {
@@ -1566,7 +1585,7 @@ PHP_DOM_EXPORT bool php_dom_create_object(xmlNodePtr obj, zval *return_value, do
 		}
 		case XML_ELEMENT_NODE:
 		{
-			ce = dom_get_element_ce(modern);
+			ce = dom_get_element_ce(obj, modern);
 			break;
 		}
 		case XML_ATTRIBUTE_NODE:

ext/dom/php_dom.stub.php

@@ -1367,6 +1367,10 @@ public function prepend(Node|string ...$nodes): void {}
         public function replaceChildren(Node|string ...$nodes): void {}
     }
 
+    class HTMLElement extends Element
+    {
+    }
+
     class Attr extends Node
     {
         /** @readonly */
@@ -1574,10 +1578,9 @@ public function replaceChildren(Node|string ...$nodes): void {}
 
         public function importLegacyNode(\DOMNode $node, bool $deep = false): Node {}
 
-        /* TODO: HTMLElement, once we decided on whether to implement that ? */
-        public ?Element $body;
+        public ?HTMLElement $body;
         /** @readonly */
-        public ?Element $head;
+        public ?HTMLElement $head;
         public string $title;
     }
 

ext/dom/php_dom_arginfo.h

@@ -11,7 +11,7 @@ function testNormalReplace($cb)
     var_dump($dom->body?->nodeName);
     try {
         $dom->body = $cb($dom);
-    } catch (DOMException $e) {
+    } catch (Throwable $e) {
         echo $e->getMessage(), "\n";
     }
     var_dump($dom->body?->nodeName);
@@ -50,11 +50,11 @@ The new body must either be a body or a frameset tag
 string(4) "BODY"
 --- Right element tag in wrong namespace ---
 string(4) "BODY"
-The new body must either be a body or a frameset tag
+Cannot assign Dom\Element to property Dom\Document::$body of type ?Dom\HTMLElement
 string(4) "BODY"
 --- Right element tag in no namespace ---
 string(4) "BODY"
-The new body must either be a body or a frameset tag
+Cannot assign Dom\Element to property Dom\Document::$body of type ?Dom\HTMLElement
 string(4) "BODY"
 --- Set body without document element ---
 A body can only be set if there is a document element

ext/dom/tests/modern/html/interactions/Document_body_setter_errors.phpt

@@ -5,7 +5,7 @@ dom
 --FILE--
 <?php
 
-class Custom extends Dom\Element {
+class Custom extends Dom\HTMLElement {
     public int $test = 1;
 
     public function reverseTagName(): string {
@@ -15,7 +15,7 @@ class Custom extends Dom\Element {
 }
 
 $dom = Dom\HTMLDocument::createFromString("<div>foo</div>", LIBXML_NOERROR);
-$dom->registerNodeClass("Dom\\Element", "Custom");
+$dom->registerNodeClass("Dom\\HTMLElement", "Custom");
 
 var_dump($dom->getElementsByTagName('div')[0]->reverseTagName());
 

ext/dom/tests/modern/html/interactions/HTMLDocument_registerNodeClass_03.phpt

@@ -5,10 +5,10 @@ dom
 --FILE--
 <?php
 
-class MyElement extends Dom\Element {}
+class MyElement extends Dom\HTMLElement {}
 
 $dom = Dom\HTMLDocument::createFromString("<p>foo</p>", LIBXML_NOERROR);
-$dom->registerNodeClass("Dom\\Element", "MyElement");
+$dom->registerNodeClass("Dom\\HTMLElement", "MyElement");
 
 // Destroy reference to the DOM
 $child = $dom->documentElement;

ext/dom/tests/modern/html/interactions/HTMLDocument_should_retain_properties_and_owner_01.phpt

@@ -5,10 +5,10 @@ dom
 --FILE--
 <?php
 
-class MyElement extends Dom\Element {}
+class MyElement extends Dom\HTMLElement {}
 
 $dom = Dom\HTMLDocument::createFromString("<p>foo</p>", LIBXML_NOERROR);
-$dom->registerNodeClass("Dom\\Element", "MyElement");
+$dom->registerNodeClass("Dom\\HTMLElement", "MyElement");
 $child = $dom->documentElement->appendChild($dom->createElement('html'));
 
 // Destroy reference to the DOM

ext/dom/tests/modern/html/interactions/HTMLDocument_should_retain_properties_and_owner_02.phpt

@@ -14,5 +14,5 @@ try {
 echo $dom->saveXml();
 ?>
 --EXPECT--
-Cannot modify readonly property Dom\Element::$prefix
+Cannot modify readonly property Dom\HTMLElement::$prefix
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>