php-doc-en/reference/dom/domnode/removechild.xml
Yannick Torres 8ef6cf9b7c Fix some literal tag
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@324735 c90b9560-bf6c-de11-be94-00142212c4b1
2012-04-03 08:12:03 +00:00

168 lines
4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='domnode.removechild' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>DOMNode::removeChild</refname>
<refpurpose>
Removes child from list of children
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>DOMNode</type><methodname>DOMNode::removeChild</methodname>
<methodparam><type>DOMNode</type><parameter>oldnode</parameter></methodparam>
</methodsynopsis>
<para>
This functions removes a child from a list of children.
</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 function returns the old child.
</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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>DOM_NOT_FOUND</constant></term>
<listitem>
<para>
Raised if <parameter>oldnode</parameter> is not a child of this node.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
The following example will delete the <literal>chapter</literal> 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="utf-8"?>
<!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>
<para>
<example>
<title>Preserving the parent node's namespace URI</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);
// copy the namespace URI
$nsuri = $book->namespaceURI;
// Delete the child node
$book->removeChild($chapter);
// paste the namespace URI back into the parent node
$book->namespaceURI = $nsuri;
?>]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
After calling this method, the <literal>DOMNode::$namespaceURI</literal>
property on the parent node will be reset to &null;. Above example shows
how to work around it.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>DOMNode::appendChild</methodname></member>
<member><methodname>DOMNode::replaceChild</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
-->