Files
doc-en/reference/dom/domdocument/adoptnode.xml
Gina Peter Banyard 7b1704c9a9 dom: Add stubs generated from php-src stubs (#2813)
* dom: Add stubs generated from php-src stubs

* Clarify string behaviour

* Update DOMChildNode::after docs

* Add docs for DOMElement::after

* Remove doc file for unimplemented, to-be-deprecated method

* Add docs for DOMCharacterData::after

* Error section for DOMChildNode::before

* Add docs for DOMCharacterData::before

* Add docs for DOMElement::before

* Update errors of DOMParentNode::append

* Document DOMElement::append

* Add docs for DOMDocument::append

* DOMParentNode::prepend errors

* Add docs for DOMDocument::prepend

* Document DOMDocumentFragment::prepend

* Better description for DOMDocument::{append,prepend} docs

* Add docs for DOMElement::prepend

* Add docs for DOMDocumentFragment::append

* Add docs for DOMCharacterData::remove

* Document DOMElement::remove

* Add docs for DOMDocument::adoptNode

* Add errors for DOMChildNode::replaceWith

* Remove misleading statement

* Fix description of DOMDocumentFragment::append example

* Fix DOMElement::remove description

* Add replaceWith docs

* Add version data

* Add docs for DOMElement::replaceChildren

* Add DOMDocument::replaceChildren docs

* Add errors for DOMParentNode::replaceChildren

* Update references for DOMDocument::replaceChildren

* Add docs for DOMDocumentFragment::replaceChildren

* Iterator docs

---------

Co-authored-by: Niels Dossche <7771979+nielsdos@users.noreply.github.com>
2023-11-12 13:40:15 +00:00

120 lines
2.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="domdocument.adoptnode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DOMDocument::adoptNode</refname>
<refpurpose>Transfer a node from another document</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="DOMDocument">
<modifier>public</modifier> <type class="union"><type>DOMNode</type><type>false</type></type><methodname>DOMDocument::adoptNode</methodname>
<methodparam><type>DOMNode</type><parameter>node</parameter></methodparam>
</methodsynopsis>
<para>
Transfer a node from another document into the current document.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>node</parameter></term>
<listitem>
<para>
The node to transfer.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The node that was transfered, or &false; on error.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<variablelist>
<varlistentry>
<term><constant>DOM_NOT_SUPPORTED_ERR</constant></term>
<listitem>
<para>
Raised if the node type is not supported for document transfers.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example xml:id="domdocument.adoptnode.example.basic">
<title><methodname>DOMDocument::adoptNode</methodname> example</title>
<para>
Transfers the hello element from the first document to the second one.
</para>
<programlisting role="php">
<![CDATA[
<?php
$doc1 = new DOMDocument;
$doc1->loadXML("<container><hello><world/></hello></container>");
$hello = $doc1->documentElement->firstChild;
$doc2 = new DOMDocument;
$doc2->loadXML("<root/>");
$doc2->documentElement->appendChild($doc2->adoptNode($hello));
echo $doc1->saveXML() . PHP_EOL;
echo $doc2->saveXML();
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
<?xml version="1.0"?>
<container/>
<?xml version="1.0"?>
<root><hello><world/></hello></root>
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>DOMDocument::importNode</methodname></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->