Implement Document::$head

Author: nielsdos

ext/dom/dom_properties.h

@@ -65,6 +65,7 @@ zend_result dom_document_substitue_entities_write(dom_object *obj, zval *newval)
 /* html5 document properties */
 zend_result dom_html_document_encoding_write(dom_object *obj, zval *retval);
 zend_result dom_html_document_body_read(dom_object *obj, zval *retval);
+zend_result dom_html_document_head_read(dom_object *obj, zval *retval);
 
 /* documenttype properties */
 zend_result dom_documenttype_name_read(dom_object *obj, zval *retval);

ext/dom/html_document.c

@@ -1366,7 +1366,7 @@ zend_result dom_html_document_encoding_write(dom_object *obj, zval *newval)
 	return FAILURE;
 }
 
-zend_result dom_html_document_body_read(dom_object *obj, zval *retval)
+zend_result dom_html_document_element_read_helper(dom_object *obj, zval *retval, bool (*accept)(const xmlChar *))
 {
 	DOM_PROP_NODE(const xmlDoc *, docp, obj);
 
@@ -1378,8 +1378,7 @@ zend_result dom_html_document_body_read(dom_object *obj, zval *retval)
 
 	xmlNodePtr cur = root->children;
 	while (cur != NULL) {
-		if (cur->type == XML_ELEMENT_NODE && php_dom_ns_is_fast(cur, php_dom_ns_is_html_magic_token)
-			&& (xmlStrEqual(cur->name, BAD_CAST "body") || xmlStrEqual(cur->name, BAD_CAST "frameset"))) {
+		if (cur->type == XML_ELEMENT_NODE && php_dom_ns_is_fast(cur, php_dom_ns_is_html_magic_token) && accept(cur->name)) {
 			php_dom_create_object(cur, retval, obj);
 			return SUCCESS;
 		}
@@ -1390,4 +1389,24 @@ zend_result dom_html_document_body_read(dom_object *obj, zval *retval)
 	return SUCCESS;
 }
 
+static bool dom_accept_body_name(const xmlChar *name)
+{
+	return xmlStrEqual(name, BAD_CAST "body") || xmlStrEqual(name, BAD_CAST "frameset");
+}
+
+static bool dom_accept_head_name(const xmlChar *name)
+{
+	return xmlStrEqual(name, BAD_CAST "head");
+}
+
+zend_result dom_html_document_body_read(dom_object *obj, zval *retval)
+{
+	return dom_html_document_element_read_helper(obj, retval, dom_accept_body_name);
+}
+
+zend_result dom_html_document_head_read(dom_object *obj, zval *retval)
+{
+	return dom_html_document_element_read_helper(obj, retval, dom_accept_head_name);
+}
+
 #endif  /* HAVE_LIBXML && HAVE_DOM */

ext/dom/php_dom.c

@@ -840,6 +840,7 @@ PHP_MINIT_FUNCTION(dom)
 	DOM_REGISTER_PROP_HANDLER(&dom_abstract_base_document_prop_handlers, "lastElementChild", dom_parent_node_last_element_child_read, NULL);
 	DOM_REGISTER_PROP_HANDLER(&dom_abstract_base_document_prop_handlers, "childElementCount", dom_parent_node_child_element_count, NULL);
 	DOM_REGISTER_PROP_HANDLER(&dom_abstract_base_document_prop_handlers, "body", dom_html_document_body_read, NULL);
+	DOM_REGISTER_PROP_HANDLER(&dom_abstract_base_document_prop_handlers, "head", dom_html_document_head_read, NULL);
 	zend_hash_merge(&dom_abstract_base_document_prop_handlers, &dom_modern_node_prop_handlers, NULL, false);
 	/* No need to register in &classes because this is an abstract class handler. */
 

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

@@ -0,0 +1,74 @@
+--TEST--
+Test DOM\Document::$head
+--EXTENSIONS--
+dom
+--FILE--
+<?php
+
+echo "--- From parsing ---\n";
+
+$dom = DOM\HTMLDocument::createFromString("<p>foo</p>", LIBXML_NOERROR);
+var_dump($dom->head?->nodeName);
+
+echo "--- After head removal ---\n";
+
+$dom->head->remove();
+var_dump($dom->head?->nodeName);
+
+echo "--- head in no namespace ---\n";
+
+$tmp = $dom->documentElement->appendChild($dom->createElementNS("", "head"));
+var_dump($dom->head?->nodeName);
+$tmp->remove();
+
+echo "--- head in right namespace ---\n";
+
+$tmp = $dom->documentElement->appendChild($dom->createElementNS("http://www.w3.org/1999/xhtml", "head"));
+var_dump($dom->head?->nodeName);
+$tmp->remove();
+
+echo "--- prefixed head in right namespace ---\n";
+
+$tmp = $dom->documentElement->appendChild($dom->createElementNS("http://www.w3.org/1999/xhtml", "prefix:head"));
+var_dump($dom->head?->nodeName);
+$tmp->remove();
+
+echo "--- multiple head elements in right namespace ---\n";
+
+$tmp1 = $dom->documentElement->appendChild($dom->createElementNS("http://www.w3.org/1999/xhtml", "prefix1:head"));
+var_dump($dom->head?->nodeName);
+$tmp2 = $dom->documentElement->appendChild($dom->createElementNS("http://www.w3.org/1999/xhtml", "prefix2:head"));
+var_dump($dom->head?->nodeName);
+$tmp1->remove();
+var_dump($dom->head?->nodeName);
+$tmp2->remove();
+var_dump($dom->head?->nodeName);
+
+echo "--- html element in no namespace ---\n";
+
+$dom = DOM\XMLDocument::createFromString(<<<XML
+<html xmlns="">
+  <head/>
+</html>
+XML);
+var_dump($dom->head);
+
+?>
+--EXPECT--
+--- From parsing ---
+string(4) "HEAD"
+--- After head removal ---
+NULL
+--- head in no namespace ---
+NULL
+--- head in right namespace ---
+string(4) "HEAD"
+--- prefixed head in right namespace ---
+string(11) "PREFIX:HEAD"
+--- multiple head elements in right namespace ---
+string(12) "PREFIX1:HEAD"
+string(12) "PREFIX1:HEAD"
+string(12) "PREFIX2:HEAD"
+NULL
+--- html element in no namespace ---
+NULL

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

@@ -23,7 +23,7 @@ var_dump(get_class($dom->getElementsByTagName("p")->item(0)));
 
 ?>
 --EXPECT--
-object(DOM\HTMLDocument)#1 (26) {
+object(DOM\HTMLDocument)#1 (27) {
   ["implementation"]=>
   string(22) "(object value omitted)"
   ["URL"]=>
@@ -48,6 +48,8 @@ object(DOM\HTMLDocument)#1 (26) {
   int(1)
   ["body"]=>
   string(22) "(object value omitted)"
+  ["head"]=>
+  string(22) "(object value omitted)"
   ["nodeType"]=>
   int(13)
   ["nodeName"]=>

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

@@ -23,7 +23,7 @@ var_dump(get_class($dom->getElementsByTagName("p")->item(0)));
 
 ?>
 --EXPECT--
-object(DOM\HTMLDocument)#1 (26) {
+object(DOM\HTMLDocument)#1 (27) {
   ["implementation"]=>
   string(22) "(object value omitted)"
   ["URL"]=>
@@ -48,6 +48,8 @@ object(DOM\HTMLDocument)#1 (26) {
   int(1)
   ["body"]=>
   string(22) "(object value omitted)"
+  ["head"]=>
+  string(22) "(object value omitted)"
   ["nodeType"]=>
   int(13)
   ["nodeName"]=>

ext/dom/tests/modern/spec/Document_implementation_createDocument.phpt

@@ -37,7 +37,7 @@ echo $dom->implementation->createDocument(null, "", $dtd)->saveXML(), "\n";
 ?>
 --EXPECT--
 --- (null, "") ---
-object(DOM\XMLDocument)#3 (30) {
+object(DOM\XMLDocument)#3 (31) {
   ["xmlEncoding"]=>
   string(5) "UTF-8"
   ["xmlStandalone"]=>
@@ -70,6 +70,8 @@ object(DOM\XMLDocument)#3 (30) {
   int(0)
   ["body"]=>
   NULL
+  ["head"]=>
+  NULL
   ["nodeType"]=>
   int(9)
   ["nodeName"]=>

ext/dom/tests/modern/xml/XMLDocument_debug.phpt

@@ -10,7 +10,7 @@ var_dump($dom);
 
 ?>
 --EXPECT--
-object(DOM\XMLDocument)#1 (30) {
+object(DOM\XMLDocument)#1 (31) {
   ["xmlEncoding"]=>
   string(5) "UTF-8"
   ["xmlStandalone"]=>
@@ -43,6 +43,8 @@ object(DOM\XMLDocument)#1 (30) {
   int(0)
   ["body"]=>
   NULL
+  ["head"]=>
+  NULL
   ["nodeType"]=>
   int(9)
   ["nodeName"]=>

ext/dom/tests/modern/xml/XMLDocument_fromEmptyDocument_02.phpt

@@ -10,7 +10,7 @@ var_dump($dom);
 
 ?>
 --EXPECT--
-object(DOM\XMLDocument)#1 (30) {
+object(DOM\XMLDocument)#1 (31) {
   ["xmlEncoding"]=>
   string(5) "UTF-8"
   ["xmlStandalone"]=>
@@ -43,6 +43,8 @@ object(DOM\XMLDocument)#1 (30) {
   int(0)
   ["body"]=>
   NULL
+  ["head"]=>
+  NULL
   ["nodeType"]=>
   int(9)
   ["nodeName"]=>

ext/dom/tests/modern/xml/XMLDocument_node_ownerDocument_for_XML.phpt

@@ -13,7 +13,7 @@ var_dump($element->ownerDocument);
 
 ?>
 --EXPECTF--
-object(DOM\XMLDocument)#1 (30) {
+object(DOM\XMLDocument)#1 (31) {
   ["xmlEncoding"]=>
   string(5) "UTF-8"
   ["xmlStandalone"]=>
@@ -46,6 +46,8 @@ object(DOM\XMLDocument)#1 (30) {
   int(1)
   ["body"]=>
   NULL
+  ["head"]=>
+  NULL
   ["nodeType"]=>
   int(9)
   ["nodeName"]=>