Skip to content

Fix dom_import_simplexml() return type #3882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 19, 2024
Merged

Fix dom_import_simplexml() return type #3882

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0a506da
Fix dom_import_simplexml() return type
cmb69 Oct 17, 2024
62f7284
Update reference/dom/functions/dom-import-simplexml.xml
cmb69 Oct 17, 2024
2c4a07f
Fix return values section, too
cmb69 Oct 17, 2024
adc06c6
Update function and parameter descriptions
cmb69 Oct 18, 2024
f775366
Clarify aliasing/view behavior and add example
cmb69 Oct 18, 2024
e94dd2b
remove trailing WS
cmb69 Oct 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 40 additions & 7 deletions reference/dom/functions/dom-import-simplexml.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,15 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>DOMElement</type><methodname>dom_import_simplexml</methodname>
<type class="union"><type>DOMAttr</type><type>DOMElement</type></type><methodname>dom_import_simplexml</methodname>
<methodparam><type>object</type><parameter>node</parameter></methodparam>
</methodsynopsis>
<para>
This function takes the node <parameter>node</parameter> of class
<link linkend="ref.simplexml">SimpleXML</link> and makes it into a
<classname>DOMElement</classname> node. This new object can then be used
as a native <classname>DOMElement</classname> node.
This function takes the given attribute or element <parameter>node</parameter> (a
<classname>SimpleXMLElement</classname> instance) and creates a
<classname>DOMAttr</classname> or <classname>DOMElement</classname> node, repectively.
The new <classname>DOMNode</classname> refers to the same underlying XML node
as the <classname>SimpleXMLElement</classname>.
</para>
</refsect1>
<refsect1 role="parameters">
Expand All @@ -29,7 +30,7 @@
<term><parameter>node</parameter></term>
<listitem>
<para>
The <classname>SimpleXMLElement</classname> node.
The attribute or element node to import (a <classname>SimpleXMLElement</classname> instance).
</para>
</listitem>
</varlistentry>
Expand All @@ -39,7 +40,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The <classname>DOMElement</classname> node added.
The <classname>DOMAttr</classname> or <classname>DOMElement</classname>.
</para>
</refsect1>

Expand Down Expand Up @@ -95,6 +96,38 @@ echo $dom->saveXML();
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
<?xml version="1.0"?>
<books><book><title>blah</title></book></books>
]]>
</screen>
</example>
<example>
<title>Import SimpleXML into DOM and modify SimpleXML through DOM</title>
<simpara>
Error handling omitted for brevity.
</simpara>
<programlisting role="php">
<![CDATA[
<?php

$sxe = simplexml_load_string('<books><book><title>blah</title></book></books>');
$elt = dom_import_simplexml($sxe);
$elt->setAttribute("foo", "bar");
echo $sxe->asXML();

?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
<?xml version="1.0"?>
<books foo="bar"><book><title>blah</title></book></books>
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
Expand Down