Add new DOM Living Standard API to ext/dom #4709

beberlei · 2019-09-15T18:51:16Z

RFC: https://wiki.php.net/rfc/dom_living_standard_api

Add new methods from https://dom.spec.whatwg.org/ (formerly https://www.w3.org/TR/dom) specification to ext/dom in a mostly backwards compatible way and "PHPify" the API

DOMParentNode

Add DOMParentNode interface
Implement reusable firstElementChild, lastElementChild, childElementCount property handlers
DOMElement instanceof DOMParentNode
DOMDocument instanceof DOMParentNode
DOMFragment instanceof DOMParentNode
Implement prepend()
Implement append()
Make sure nodes from other documents throw WRONG_DOCUMENT error for now.

We leave out DOMParentNode#querySelector and querySelectorAll and leave open to include them in a new interface later. In any case translating CSS Selectors to XPath should be a userland concern, Symfony CSS Selector and FluentDOM PhpCSS are good examples.

DOMNonDocumentTypeChildNode

This interface is not actually added, instead added previousElementSibling, nextElementSibling property handlers directly on all classes that implement DOMChildNode.

Implement reusable previousElementSibling, nextElementSibling property handlers
Add to DOMElement
Add to DOMCharacterData

DOMChildNode

Add DOMChildNode interface
DOMElement instanceof DOMChildNode
DOMCharacterData instanceof DOMChildNode
Implement remove()
Implement before()
Implement after()
Implement replaceWith()
Make sure nodes from other documents throw WRONG_DOCUMENT error for now.

Implementation Todos

Refactor reusable parts from all append, prepend, before, after methods instead of code duplication used now. (better be done after RFC acceptance)
Complete arginfo definitions (depends on Convert dom methods arginfo to PHP stubs #4721)
Add much more tests.
Add Reconcile Namespaces behavior to all new methods
Add relevant error handling for edge cases (read only, hierachy errors, ...)

Testing

git clone [email protected]:php/php-src.git
cd php-src
git remote add beberlei [email protected]:beberlei/php-src.git
git fetch beberlei
git checkout -bDomLivingStandard beberlei/DomLivingStandard
./buildconf
./configure  --prefix=/opt/php/php-src --disable-all --with-zlib --enable-xml --with-libxml --enable-dom --enable-debug
make -j4
TESTS=ext/dom/tests/*.phpt make test

…st failures.

First implementation of DOMElement#remove()

…adic arguments.

…y type to string and turn them to DOMTextNode

…ations to DOMDocument+DOMDocumentFragment for now.

…d+prepend.

…terData.

ecreeth · 2019-11-20T23:55:27Z

Great! Although I would like the DOM and HTML to be handled as XHP in Hacklang.
I think that if this is officially implemented in PHP, it will be the second best new feature in PHP after JIT in the 8.0 version. 🚀 Thanks for this!.

I would pay for xhp in PHP! 😍

beberlei · 2019-12-08T17:18:32Z

@cscott Nothing you mention has anything to do with this RFC. Can you please specify what you mean incompatible with PHP DOM.

As the RFC mentions, we are adopting the WHATWG DOM Living Standard changes to how PHP DOM works to keep the existing behaviors. We just add the new methods and their behavior in a way that is compatible with how PHP DOM works today.

I don't believe it makes sense to break the API of ext/dom, because when people use ext/dom to mainipulate or traverse xml documents, this is usually wide-spread, requires a fair bit of code, and might therefore not really easy to migrate.

Overall, the PHP DOM extension should continue to be inspired by the DOM Stanndard, but breaking BC to followß it at this point is out of the questino and doesn't serve a good purpose. My idea would rather be thta we add a page to the documentation explaining the differences.

beberlei · 2019-12-08T17:21:53Z

@cscott by the way, I have reviewed the wikimedia ticket a few times before already, but it contains a misconception about missing HTML XML functionality (innerHTML, uppercase tags, body property). ext/dom is about XML and doesn't aim to implement the HTML standards extensions to it at this time.

ext/dom/characterdata.c

ext/dom/node.c

ext/dom/parentnode.c

nikic · 2020-01-27T14:24:47Z

ext/dom/parentnode.c

+			xmlSetTreeDoc(newNode, documentNode);
+
+			if (!xmlAddChild(fragment, newNode)) {
+				return NULL;


Unlike the case above, this doesn't generate an error.

Its not a type error, as it is a string, not sure what to do here. the return value from xmlAddChild is not checked everywhere in the existing code base.

I meant the php_dom_throw_error(HIERARCHY_REQUEST_ERR, stricterror); error above. Though I guess that can't happen if the added node is newly created?

ext/dom/tests/DOM4_DOMNode_after.phpt

ext/dom/tests/DOM4_DOMNode_before.phpt

ext/dom/tests/DOM4_DOMNode_replaceWith.phpt

ext/dom/tests/DOM4_ParentNode_append_invalidtypes.phpt

ext/dom/tests/tmp_dom_savexml1573214655

… assertions, after/before are loosing elements.

ext/dom/dom.stub.php

nikic · 2020-02-18T15:41:21Z

ext/dom/parentnode.c

+			xmlSetTreeDoc(newNode, documentNode);
+
+			if (!xmlAddChild(fragment, newNode)) {
+				return NULL;


I meant the php_dom_throw_error(HIERARCHY_REQUEST_ERR, stricterror); error above. Though I guess that can't happen if the added node is newly created?

nikic · 2020-02-18T15:47:28Z

ext/dom/parentnode.c

+
+	if (newchild) {
+		parentNode->children = newchild;
+		newchild->prev = prevsib;


Both the prevsib variable and this assignment look unnecessary to me. prevsib is always NULL, and newchild->prev should also be NULL already.

Yeah this was left over so that each method looks as equal to the previous ones so I can more easily find common things to refactor out later. They are too different though, except the parent node assignment so i cleaned this up now.

ext/dom/parentnode.c

ext/dom/tests/DOM4_DOMNode_ElementSiblings.phpt

nikic · 2020-02-28T09:46:10Z

ext/dom/parentnode.c

+
+		newchild->prev = prevsib;
+
+


nit: double newline

beberlei · 2020-02-28T15:18:31Z

Merged in 5acd86d

beberlei and others added 28 commits September 15, 2019 20:35

dom: Let DOMElement implement DOM Level 4 DOMParentNode interface

a64d792

[dom] Have DOMDocument implement DOMParentNode.

506fd39

[dom] Add DOMParentNode implementation to DOMDocumentFragment. Fix te…

4f3796e

…st failures.

[dom] Add DOMNode#previousElementSibling and DOMNode#nextElementSibling.

799db74

[dom] DomChildNode#remove interface and DOMElement implementation

865f65f

First implementation of DOMElement#remove()

[dom] fix parameter parsing for DomElement#remove()

adce6d1

RETURN_NULL as proto is always void.

18d4395

Test: DOM Level4 DOMNode::remove()

07362cd

Test: DOM Level4 DOMNode::before()

ca72b19

Test: DOM Level4 DOMNode::after()

33368a0

Test: DOM Level4 DOMNode::replaceWith()

6b1d65e

Test: DOM Level4 DOMParentNode::prepend()

46a3248

Test: DOM Level4 DOMParentNode::append()

94b7500

Add DOMParentNode::append() for DOMElement supporting strings as vari…

fc6c639

…adic arguments.

Adopt DoMNode into fragment when passed an object.

c62b8b5

Refactor converting zval array into dom fragment into function.

ece10c6

Add DOMElement::prepend.

0670bdd

Refactor dom_zvals_to_fragment to convert all non DOMNode zvals of an…

518583d

…y type to string and turn them to DOMTextNode

Add prepend/append to DOMParentNode interface and add dummy implement…

36f299b

…ations to DOMDocument+DOMDocumentFragment for now.

Add docs to DOMParentNode methods.

f03fbae

Add code for DOMDocument+DOMDocumentFragment implementations of appen…

080ee99

…d+prepend.

Add DOMElement::after() and ::before() stubs.

cb5bffa

Implement DOMElement::after() and DOMElement::before()

4021b9e

Make DOMCharacterData implements DOMChildNode

7fa76e6

Test: DOM Level4 node adoption and append with attributes

1b08995

Add namespace reconcile support for append/prepend/after/before.

c6f732c

Update tests.

7e6528a

Prototype on node adoption.

3165e36

carusogabriel added the RFC label Sep 15, 2019

Move previous/nextElementSibling from DOMNode to DOMElement+DOMCharac…

553e073

…terData.

beberlei added 3 commits January 26, 2020 23:26

merge master into DomLivingStandard

c4ac9a4

Expand on append() test

66ea5b1

Expand on ::prepend() test.

7daaf9b

kocsismate reviewed Jan 27, 2020

View reviewed changes

ext/dom/characterdata.c Outdated Show resolved Hide resolved

nikic reviewed Jan 27, 2020

View reviewed changes

beberlei added 9 commits February 6, 2020 22:25

Merge branch 'master' into DomLivingStandard

c0741a3

Remove trailing whitespaces from Node Content: test output.

eac2482

Add more things to prepend test.

0fef8ec

Apply review comments, improve test output and add more complexity to…

9cf62b6

… assertions, after/before are loosing elements.

RETURN_THROWS

d875308

Free memory appropriately

9b79816

Bugfix: after/before loosing nodes.

2031c2b

Move empty children test into prepend function to avoid duplication.

1c497bc

Add test for DOMNode#remove with dangling element causing error.

3bc655e

nikic reviewed Feb 18, 2020

View reviewed changes

beberlei added 5 commits February 27, 2020 19:51

Cleanup tests

e3f7983

Fix stub style

0372245

Factor out dom_parent_node_assign_parent

363e4f8

Centralize newchild->prev assignment to the end everywhere.

c686680

Cleanup fragment and parent node assignment.

7be07e4

beberlei requested a review from nikic February 28, 2020 09:00

nikic approved these changes Feb 28, 2020

View reviewed changes

ext/dom/parentnode.c

newchild->prev = prevsib;

Copy link

Member

nikic Feb 28, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: double newline

beberlei closed this Feb 28, 2020

carusogabriel added this to the PHP 8.0 milestone May 29, 2020

mumumu mentioned this pull request May 15, 2021

Added PHP 8 into versions.xml for dom based on stubs. php/doc-en#431

Merged

jrfnl mentioned this pull request Aug 4, 2023

PHP 8.0 | NewInterfaces: add support for DOM living standard APIs related interfaces (RFC) PHPCompatibility/PHPCompatibility#1595

Merged

Add new DOM Living Standard API to ext/dom #4709

Add new DOM Living Standard API to ext/dom #4709

Uh oh!

Conversation

beberlei commented Sep 15, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

DOMParentNode

DOMNonDocumentTypeChildNode

DOMChildNode

Implementation Todos

Testing

Uh oh!

ecreeth commented Nov 20, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I would pay for xhp in PHP! 😍

Uh oh!

beberlei commented Dec 8, 2019

Uh oh!

beberlei commented Dec 8, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nikic Jan 27, 2020

Choose a reason for hiding this comment

Uh oh!

beberlei Feb 6, 2020

Choose a reason for hiding this comment

Uh oh!

nikic Feb 18, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nikic Feb 18, 2020

Choose a reason for hiding this comment

Uh oh!

nikic Feb 18, 2020

Choose a reason for hiding this comment

Uh oh!

beberlei Feb 27, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

nikic Feb 28, 2020

Choose a reason for hiding this comment

Uh oh!

beberlei commented Feb 28, 2020

Uh oh!

Uh oh!

beberlei commented Sep 15, 2019 •

edited

Loading

ecreeth commented Nov 20, 2019 •

edited

Loading