php-doc-en/reference/dom/functions/dom-domnode-removechild.xml
Mehdi Achour 6f232afc58 Added most of the remaining properties descriptions
Cleared 5 more methods


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@175177 c90b9560-bf6c-de11-be94-00142212c4b1
2004-12-20 19:58:25 +00:00

114 lines
2.8 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<refentry id='function.dom-domnode-removechild'>
<refnamediv>
<refname>DOMNode->removeChild</refname>
<refpurpose>
Removes child from list of children
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMNode</classname></ooclass>
<methodsynopsis>
<type>DOMNode</type>
<methodname>removeChild</methodname>
<methodparam><type>DOMNode</type><parameter>oldnode</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
This functions removes a child from a list of children.
</para>
<para>
Throws <classname>DOMException</classname> if the node cannot be removed.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>oldnode</parameter></term>
<listitem>
<para>
The removed child.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
If the child could be removed the functions returns the old child.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
The following example will delete the chapter element of our XML document.
<example>
<title>Removing a child</title>
<programlisting role="php">
<![CDATA[
<?php
$doc = new DOMDocument;
$doc->load('book.xml');
$book = $doc->documentElement;
// we retrieve the chapter and remove it from the book
$chapter = $book->getElementsByTagName('chapter')->item(0);
$oldchapter = $book->removeChild($chapter);
echo $doc->saveXML();
?>]]>
</programlisting>
&example.outputs;
<screen role="xml">
<![CDATA[
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<book id="listing">
<title>My lists</title>
</book>
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link linkend="function.dom-domnode-appendchild">DOMNode->appendChild()</link></member>
<member><link linkend="function.dom-domnode-replacechild">DOMNode->replaceChild()</link></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:"../../../../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
-->