replacechild.xml

<?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-&gt;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;
  <simpara>
   May throw a <exceptionname>DOMException</exceptionname> with the
   following error codes:
  </simpara>
  <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
-->