php-doc-en/reference/dom/domdocument/importnode.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

145 lines
3.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="domdocument.importnode" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>DOMDocument::importNode</refname>
<refpurpose>Import node into current document</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>DOMNode</type><methodname>DOMDocument::importNode</methodname>
<methodparam><type>DOMNode</type><parameter>importedNode</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>deep</parameter></methodparam>
</methodsynopsis>
<para>
This function returns a copy of the node to import and associates it with
the current document.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>importedNode</parameter></term>
<listitem>
<para>
The node to import.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>deep</parameter></term>
<listitem>
<para>
If set to &true;, this method will recursively import the subtree under
the <parameter>importedNode</parameter>.
</para>
<note>
<para>
To copy the nodes attributes <parameter>deep</parameter> needs to be set to &true;
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The copied node or &false;, if it cannot be copied.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<classname>DOMException</classname> is thrown if node cannot be imported.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>DOMDocument::importNode</function> example</title>
<para>
Copying nodes between documents.
</para>
<programlisting role="php">
<![CDATA[
<?php
$orgdoc = new DOMDocument;
$orgdoc->loadXML("<root><element><child>text in child</child></element></root>");
// The node we want to import to a new document
$node = $orgdoc->getElementsByTagName("element")->item(0);
// Create a new document
$newdoc = new DOMDocument;
$newdoc->formatOutput = true;
// Add some markup
$newdoc->loadXML("<root><someelement>text in some element</someelement></root>");
echo "The 'new document' before copying nodes into it:\n";
echo $newdoc->saveXML();
// Import the node, and all its children, to the document
$node = $newdoc->importNode($node, true);
// And then append it to the "<root>" node
$newdoc->documentElement->appendChild($node);
echo "\nThe 'new document' after copying the nodes into it:\n";
echo $newdoc->saveXML();
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
The 'new document' before copying nodes into it:
<?xml version="1.0"?>
<root>
<someelement>text in some element</someelement>
</root>
The 'new document' after copying the nodes into it:
<?xml version="1.0"?>
<root>
<someelement>text in some element</someelement>
<element>
<child>text in child</child>
</element>
</root>
]]>
</screen>
</example>
</para>
</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
-->