Migrate DOMNode->xx(), add see also, explains parameters and return values

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@175675 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2004-12-27 13:51:39 +00:00
parent 87a79b78ff
commit b8ee5120a2
12 changed files with 470 additions and 227 deletions

View file

@ -1,8 +1,8 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id='function.dom-domnode-appendchild'>
<refnamediv>
<refname>DOMNode->appendChild</refname>
<refname>DOMNode->appendChild()</refname>
<refpurpose>
Adds new child at the end of the children
</refpurpose>
@ -19,13 +19,10 @@
</classsynopsis>
<para>
This functions appends a child to an existing list of children or creates
a new list of children. The child can be created with e.g.
<link linkend="function.dom-domdocument-createelement">DOMDocument->createElement()</link>,
<link linkend="function.dom-domdocument-createtextnode">DOMDocument->createTextNode()</link>
etc. or simply by using any other node.
</para>
<para>
Throws <classname>DOMException</classname> if the node cannot be appended.
a new list of children. The child can be created with e.g. <xref
linkend="function.dom-domdocument-createelement" />, <xref
linkend="function.dom-domdocument-createtextnode" /> etc. or simply by using
any other node.
</para>
</refsect1>
<refsect1 role="parameters">
@ -49,6 +46,12 @@
The node added.
</para>
</refsect1>
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
Throws <classname>DOMException</classname> if the node cannot be appended.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
@ -75,8 +78,8 @@ echo $doc->saveXML();
&reftitle.seealso;
<para>
<simplelist>
<member><link linkend="function.dom-domnode-removechild">DOMNode->removeChild()</link></member>
<member><link linkend="function.dom-domnode-replacechild">DOMNode->replaceChild()</link></member>
<member><xref linkend="function.dom-domnode-removechild" /></member>
<member><xref linkend="function.dom-domnode-replacechild" /></member>
</simplelist>
</para>
</refsect1>

View file

@ -1,29 +1,49 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<refentry id='function.dom-domnode-clonenode'>
<refnamediv>
<refname>DOMNode->cloneNode</refname>
<refpurpose>
Clones a node
</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMNode</classname></ooclass>
<methodsynopsis>
<type>DOMNode</type>
<methodname>cloneNode</methodname>
<methodparam choice="opt"><type>bool</type><parameter>deep</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Creates a copy of the node. The parameter <parameter>deep</parameter>
indicates whether to copy all descendant nodes. This parameter is
defaulted to &false;.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.6 $ -->
<refentry id='function.dom-domnode-clonenode'>
<refnamediv>
<refname>DOMNode->cloneNode()</refname>
<refpurpose>
Clones a node
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMNode</classname></ooclass>
<methodsynopsis>
<type>DOMNode</type>
<methodname>cloneNode</methodname>
<methodparam choice="opt"><type>bool</type><parameter>deep</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Creates a copy of the node.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>deep</parameter></term>
<listitem>
<para>
Indicates whether to copy all descendant nodes. This parameter is
defaulted to &false;.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The cloned node.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,8 +1,8 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id='function.dom-domnode-hasattributes'>
<refnamediv>
<refname>DOMNode->hasAttributes</refname>
<refname>DOMNode->hasAttributes()</refname>
<refpurpose>
Checks if node has attributes
</refpurpose>
@ -18,7 +18,8 @@
</methodsynopsis>
</classsynopsis>
<para>
This function checks if the node has attributes.
This method checks if the node has attributes. The tested node have to be
an <constant>XML_ELEMENT_NODE</constant>.
</para>
</refsect1>
<refsect1 role="returnvalues">
@ -27,6 +28,14 @@
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.dom-domnode-haschildnodes" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,8 +1,8 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id='function.dom-domnode-haschildnodes'>
<refnamediv>
<refname>DOMNode->hasChildNodes</refname>
<refname>DOMNode->hasChildNodes()</refname>
<refpurpose>
Checks if node has children
</refpurpose>
@ -27,6 +27,14 @@
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.dom-domnode-hasattributes" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,35 +1,66 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry id='function.dom-domnode-insertbefore'>
<refnamediv>
<refname>DOMNode->insertBefore</refname>
<refpurpose>
Adds new child at the end of the children
</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMNode</classname></ooclass>
<methodsynopsis>
<type>DOMNode</type>
<methodname>insertBefore</methodname>
<methodparam><type>DOMNode</type><parameter>newnode</parameter></methodparam>
<methodparam choice="opt"><type>DOMNode</type><parameter>refnode</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
This function inserts the new node <parameter>newnode</parameter> right
before the node <parameter>refnode</parameter>. The return value is the
inserted node. If you plan to do further modifications on the appended
child you must use the returned node. If refnode is not supplied then
<parameter>newnode</parameter> is appended to the children.
</para>
<para>
Throws <classname>DOMException</classname> if node cannot be inserted.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.5 $ -->
<refentry id='function.dom-domnode-insertbefore'>
<refnamediv>
<refname>DOMNode->insertBefore()</refname>
<refpurpose>
Adds new child at the end of the children
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMNode</classname></ooclass>
<methodsynopsis>
<type>DOMNode</type>
<methodname>insertBefore</methodname>
<methodparam><type>DOMNode</type><parameter>newnode</parameter></methodparam>
<methodparam choice="opt"><type>DOMNode</type><parameter>refnode</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
This function inserts a new node right before the reference node.
If you plan to do further modifications on the appended child you must use
the returned node.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>newnode</parameter></term>
<listitem>
<para>
The new node.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>refnode</parameter></term>
<listitem>
<para>
The reference node. If not supplied, <parameter>newnode</parameter> is
appended to the children.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The inserted node.
</para>
</refsect1>
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
Throws <classname>DOMException</classname> if node cannot be inserted.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,28 +1,49 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<refentry id='function.dom-domnode-issamenode'>
<refnamediv>
<refname>DOMNode->isSameNode</refname>
<refpurpose>
Indicates if two nodes are the same node
</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMNode</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>isSameNode</methodname>
<methodparam><type>DOMNode</type><parameter>node</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
This functions indicates if two nodes are the same node.
The comparison is <emphasis>not</emphasis> based on content
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.6 $ -->
<refentry id='function.dom-domnode-issamenode'>
<refnamediv>
<refname>DOMNode->isSameNode()</refname>
<refpurpose>
Indicates if two nodes are the same node
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMNode</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>isSameNode</methodname>
<methodparam><type>DOMNode</type><parameter>node</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
This function indicates if two nodes are the same node.
The comparison is <emphasis>not</emphasis> based on content
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>node</parameter></term>
<listitem>
<para>
The compared node.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,29 +1,68 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<refentry id="function.dom-domnode-issupported">
<refnamediv>
<refname>DOMNode->isSupported</refname>
<refpurpose>
Checks if feature is supported for specified version
</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMNode</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>isSupported</methodname>
<methodparam><type>string</type><parameter>feature</parameter></methodparam>
<methodparam><type>string</type><parameter>version</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Checks if the asked <parameter>feature</parameter> is supported for the
specified <parameter>version</parameter>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.6 $ -->
<refentry id="function.dom-domnode-issupported">
<refnamediv>
<refname>DOMNode->isSupported()</refname>
<refpurpose>
Checks if feature is supported for specified version
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMNode</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>isSupported</methodname>
<methodparam><type>string</type><parameter>feature</parameter></methodparam>
<methodparam><type>string</type><parameter>version</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Checks if the asked <parameter>feature</parameter> is supported for the
specified <parameter>version</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>feature</parameter></term>
<listitem>
<para>
The feature to test. See the example of
<xref linkend="function.dom-domimplementation-hasfeature" /> for a
list of features.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>version</parameter></term>
<listitem>
<para>
The version number of the <parameter>feature</parameter> to test.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.dom-domimplementation-hasfeature" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,27 +1,57 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry id='function.dom-domnode-lookupnamespaceuri'>
<refnamediv>
<refname>DOMNode->lookupNamespaceURI</refname>
<refpurpose>
Returns namespace URI of the node based on the prefix
</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMNode</classname></ooclass>
<methodsynopsis>
<type>string</type>
<methodname>lookupNamespaceURI</methodname>
<methodparam><type>string</type><parameter>prefix</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Returns namespace URI of the node based on the prefix.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.5 $ -->
<refentry id='function.dom-domnode-lookupnamespaceuri'>
<refnamediv>
<refname>DOMNode->lookupNamespaceURI()</refname>
<refpurpose>
Gets the namespace URI of the node based on the prefix
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMNode</classname></ooclass>
<methodsynopsis>
<type>string</type>
<methodname>lookupNamespaceURI</methodname>
<methodparam><type>string</type><parameter>prefix</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Gets the namespace URI of the node based on the
<parameter>prefix</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>prefix</parameter></term>
<listitem>
<para>
The prefix of the namespace.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The namespace URI of the node.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.dom-domnode-lookupprefix" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,27 +1,56 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry id='function.dom-domnode-lookupprefix'>
<refnamediv>
<refname>DOMNode->lookupPrefix</refname>
<refpurpose>
Returns name space prefix of the node based on namespaceURI
</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMNode</classname></ooclass>
<methodsynopsis>
<type>string</type>
<methodname>lookupPrefix</methodname>
<methodparam><type>string</type><parameter>namespaceURI</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Returns name space prefix of the node based on namespaceURI.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.5 $ -->
<refentry id='function.dom-domnode-lookupprefix'>
<refnamediv>
<refname>DOMNode->lookupPrefix()</refname>
<refpurpose>
Gets the namespace prefix of the node based on the namespace URI
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMNode</classname></ooclass>
<methodsynopsis>
<type>string</type>
<methodname>lookupPrefix</methodname>
<methodparam><type>string</type><parameter>namespaceURI</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Gets the namespace prefix of the node based on the namespace URI.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>namespaceURI</parameter></term>
<listitem>
<para>
The namespace URI.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The prefix of the namespace.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.dom-domnode-lookupnamespaceuri" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,27 +1,35 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry id="function.dom-domnode-normalize">
<refnamediv>
<refname>DOMNode->normalize</refname>
<refpurpose>
Normalizes the node
</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMNode</classname></ooclass>
<methodsynopsis>
<type>void</type>
<methodname>normalize</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>
Normalizes the node.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.5 $ -->
<refentry id="function.dom-domnode-normalize">
<refnamediv>
<refname>DOMNode->normalize()</refname>
<refpurpose>
Normalizes the node
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMNode</classname></ooclass>
<methodsynopsis>
<type>void</type>
<methodname>normalize</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>
Normalizes the node.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.dom-domdocument-normalize" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,8 +1,8 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id='function.dom-domnode-removechild'>
<refnamediv>
<refname>DOMNode->removeChild</refname>
<refname>DOMNode->removeChild()</refname>
<refpurpose>
Removes child from list of children
</refpurpose>
@ -20,9 +20,6 @@
<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;
@ -45,6 +42,12 @@
If the child could be removed the functions returns the old child.
</para>
</refsect1>
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
Throws <classname>DOMException</classname> if the node cannot be removed.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
@ -85,8 +88,8 @@ echo $doc->saveXML();
&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>
<member><xref linkend="function.dom-domnode-appendchild" /></member>
<member><xref linkend="function.dom-domnode-replacechild" /></member>
</simplelist>
</para>
</refsect1>

View file

@ -1,34 +1,76 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<refentry id='function.dom-domnode-replacechild'>
<refnamediv>
<refname>DOMNode->replaceChild</refname>
<refpurpose>
Replaces a child
</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMNode</classname></ooclass>
<methodsynopsis>
<type>DOMNode</type>
<methodname>replaceChild</methodname>
<methodparam><type>DOMNode</type><parameter>newnode</parameter></methodparam>
<methodparam><type>DOMNode</type><parameter>oldnode</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
This function replaces the child <parameter>oldnode</parameter>
with the passed new node. If the new node is already a child it
will not be added a second time. If the replacement succeeds the old node
is returned.
</para>
<para>
Throws <classname>DOMException</classname> if node cannot be replaced.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.6 $ -->
<refentry id='function.dom-domnode-replacechild'>
<refnamediv>
<refname>DOMNode->replaceChild()</refname>
<refpurpose>
Replaces a child
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMNode</classname></ooclass>
<methodsynopsis>
<type>DOMNode</type>
<methodname>replaceChild</methodname>
<methodparam><type>DOMNode</type><parameter>newnode</parameter></methodparam>
<methodparam><type>DOMNode</type><parameter>oldnode</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
This function replaces the child <parameter>oldnode</parameter>
with the passed new node. If the new node 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>newnode</parameter></term>
<listitem>
<para>
The new node.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>oldnode</parameter></term>
<listitem>
<para>
The old node.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The old node of &false; if an error occur.
</para>
</refsect1>
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
Throws <classname>DOMException</classname> if node cannot be replaced.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.dom-domnode-appendchild" /></member>
<member><xref linkend="function.dom-domnode-removechild" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables: