1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="domnode.replacechild" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>DOMNode::replaceChild</refname>
<refpurpose>
Replaces a child
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="DOMNode">
<modifier>public</modifier> <type class="union"><type>DOMNode</type><type>false</type></type><methodname>DOMNode::replaceChild</methodname>
<methodparam><type>DOMNode</type><parameter>node</parameter></methodparam>
<methodparam><type>DOMNode</type><parameter>child</parameter></methodparam>
</methodsynopsis>
<para>
This function replaces the child <parameter>child</parameter>
with the passed new node. If the <parameter>node</parameter> is already a child it
will not be added a second time. If the replacement succeeds the
old node is returned.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>node</parameter></term>
<listitem>
<para>
The new node. It must be a member of the target document, i.e.
created by one of the DOMDocument->createXXX() methods or imported in
the document by <xref linkend="domdocument.importnode"/>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>child</parameter></term>
<listitem>
<para>
The old node.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The old node or &false; if an error occur.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<variablelist>
<varlistentry>
<term><constant>DOM_NO_MODIFICATION_ALLOWED_ERR</constant></term>
<listitem>
<para>
Raised if this node is readonly or if the previous parent of the node
being inserted is readonly.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>DOM_HIERARCHY_REQUEST_ERR</constant></term>
<listitem>
<para>
Raised if this node is of a type that does not allow children of the
type of the <parameter>node</parameter> node, or if the node to
put in is one of this node's ancestors or this node itself.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>DOM_WRONG_DOCUMENT_ERR</constant></term>
<listitem>
<para>
Raised if <parameter>node</parameter> was created from a different
document than the one that created this node.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>DOM_NOT_FOUND_ERR</constant></term>
<listitem>
<para>
Raised if <parameter>child</parameter> is not a child of this node.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>DOMChildNode::replaceWith</methodname></member>
<member><methodname>DOMNode::appendChild</methodname></member>
<member><methodname>DOMNode::removeChild</methodname></member>
</simplelist>
</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
-->
|