Fix dom_import_simplexml() return type

[cmb69]

See php/php-src#16489.

[nielsdos]

The documentation of this function is also a bit whack...

Description:

This function takes the node node of class SimpleXML and makes it into a DOMElement node. This new object can then be used as a native DOMElement node.

This is inaccurate now

Return values:

The DOMElement node added.

What ??? What does added even mean here?

[cmb69]

What ??? What does added even mean here?

Indeed, makes no sense, so updated. (a bit sad, though, since it would have had its 20th birthday in a couple of weeks ;)

Before updating/improving/fixing the description, could you please have a look at the implementation of dom_import_simplexml_common():

https://github.com/php/php-src/blob/42e179ef9dc7f5b8cf6f1135c6be8e7ffe4aa5cb/ext/dom/php_dom.c#L566-L570

Is it really okay to cast an arbitrary object to a php_libxml_node_object?

[nielsdos]

Note that php_libxml_import_node will fail if the object is not actually an xml object.
I suppose it would be cleaner to check failure of php_libxml_import_node first and only then do the cast, but I don't think the current ordering hurts.

[cmb69]

Ah, I've overlooked php_libxml_import_node!

I've pushed a further commit regarding the function and the parameter descriptions. However, it seems to me that not only SimpleXMLElements can be imported, but rather arbitrary objects which have been registered with libxml. Might be worth to document that at some time.

[nielsdos]

Indeed it's broader than simplexml. However, in practice only DOM & simplexml register handlers to be able to do it.
Also a small nit on wording: you used "convert", but it's not actually converting in the sense that it's a clone; they're working on the same xml nodes so it's more like creating a "view". i.e. changes you make via dom are gonna be visible in simplexml and vice versa.

[cmb69]

Thanks for the clarification! I tried to improve the wording, and added a respective example.

[nielsdos]

Thanks a lot!