document DOMElement->setIdAttribute*() and DomNode->isDefaultNameSpace()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@225980 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2006-12-29 00:40:54 +00:00
parent b2485a06de
commit ae447c60cd
6 changed files with 293 additions and 52 deletions

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<refentry id="function.dom-domdocument-getelementbyid">
<refnamediv>
<refname>DOMDocument->getElementById()</refname>
@ -20,8 +20,10 @@
searches for an element with a given id.
</para>
<para>
According to the DOM standard this requires a DTD which defines the
attribute ID to be of type ID. You need to validate your document with
For this function to work, you will need either to set some ID attributes
with <xref linkend="function.dom-domelement-setidattribute" />
or a DTD which defines an attribute to be of type ID.
In the later case, you will need to validate your document with
<xref linkend="function.dom-domdocument-validate" />
or <literal>DOMDocument->validateOnParse</literal> before using this function.
</para>

View file

@ -1,25 +1,89 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.dom-domelement-setidattribute">
<refnamediv>
<refname>DOMElement::setIdAttribute</refname>
<refname>DOMElement->setIdAttribute()</refname>
<refpurpose>Declares the attribute specified by name to be of type ID</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>DOMElement::setIdAttribute</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>bool</type><parameter>isId</parameter></methodparam>
</methodsynopsis>
<classsynopsis>
<ooclass><classname>DOMElement</classname></ooclass>
<methodsynopsis>
<type>void</type><methodname>setIdAttribute</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>bool</type><parameter>isId</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
<ulink url="&url.dom3.spec;#core-ID-ElSetIdAttr">Specification</ulink>
Declares the attribute <parameter>name</parameter> to be of type ID.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
The name of the attribute.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>isId</parameter></term>
<listitem>
<para>
Set it to &true; if you want <parameter>name</parameter> to be of type
ID, &false; otherwise.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<variablelist>
<varlistentry>
<term><constant>DOM_NO_MODIFICATION_ALLOWED_ERR</constant></term>
<listitem>
<para>
Raised if the node is readonly.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>DOM_NOT_FOUND</constant></term>
<listitem>
<para>
Raised if <parameter>name</parameter> is not an attribute of this element.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.dom-domdocument-getelementbyid" /></member>
<member><xref linkend="function.dom-domelement-setidattributenode" /></member>
<member><xref linkend="function.dom-domelement-setidattributens" /></member>
</simplelist>
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,24 +1,90 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.dom-domelement-setidattributenode">
<refnamediv>
<refname>DOMElement::setIdAttributeNode</refname>
<refname>DOMElement->setIdAttributeNode()</refname>
<refpurpose>Declares the attribute specified by node to be of type ID</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>DOMElement::setIdAttributeNode</methodname>
<methodparam><type>attr</type><parameter>idAttr</parameter></methodparam>
<methodparam><type>bool</type><parameter>isId</parameter></methodparam>
</methodsynopsis>
<classsynopsis>
<ooclass><classname>DOMElement</classname></ooclass>
<methodsynopsis>
<type>void</type><methodname>setIdAttributeNode</methodname>
<methodparam><type>DOMAttr</type><parameter>attr</parameter></methodparam>
<methodparam><type>bool</type><parameter>isId</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
<ulink url="&url.dom3.spec;#core-ID-ElSetIdAttrNode">Specification</ulink>
Declares the attribute specified by <parameter>attr</parameter> to be of
type ID.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>attr</parameter></term>
<listitem>
<para>
The attribute node.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>isId</parameter></term>
<listitem>
<para>
Set it to &true; if you want <parameter>name</parameter> to be of type
ID, &false; otherwise.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<variablelist>
<varlistentry>
<term><constant>DOM_NO_MODIFICATION_ALLOWED_ERR</constant></term>
<listitem>
<para>
Raised if the node is readonly.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>DOM_NOT_FOUND</constant></term>
<listitem>
<para>
Raised if <parameter>name</parameter> is not an attribute of this element.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.dom-domdocument-getelementbyid" /></member>
<member><xref linkend="function.dom-domelement-setidattribute" /></member>
<member><xref linkend="function.dom-domelement-setidattributens" /></member>
</simplelist>
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,25 +1,99 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.dom-domelement-setidattributens">
<refnamediv>
<refname>DOMElement::setIdAttributeNs</refname>
<refname>DOMElement->setIdAttributeNS()</refname>
<refpurpose>Declares the attribute specified by local name and namespace URI to be of type ID</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>DOMElement::setIdAttributeNs</methodname>
<methodparam><type>string</type><parameter>namespaceURI</parameter></methodparam>
<methodparam><type>string</type><parameter>localName</parameter></methodparam>
<methodparam><type>bool</type><parameter>isId</parameter></methodparam>
</methodsynopsis>
<classsynopsis>
<ooclass><classname>DOMElement</classname></ooclass>
<methodsynopsis>
<type>void</type><methodname>setIdAttributeNS</methodname>
<methodparam><type>string</type><parameter>namespaceURI</parameter></methodparam>
<methodparam><type>string</type><parameter>localName</parameter></methodparam>
<methodparam><type>bool</type><parameter>isId</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
<ulink url="&url.dom3.spec;#core-ID-ElSetIdAttrNS">Specification</ulink>
Declares the attribute specified by <parameter>localName</parameter> and
<parameter>namespaceURI</parameter> to be of type ID.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>namespaceURI</parameter></term>
<listitem>
<para>
The namespace URI of the attribute.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>localName</parameter></term>
<listitem>
<para>
The local name of the attribute, as <literal>prefix:tagname</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>isId</parameter></term>
<listitem>
<para>
Set it to &true; if you want <parameter>name</parameter> to be of type
ID, &false; otherwise.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<variablelist>
<varlistentry>
<term><constant>DOM_NO_MODIFICATION_ALLOWED_ERR</constant></term>
<listitem>
<para>
Raised if the node is readonly.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>DOM_NOT_FOUND</constant></term>
<listitem>
<para>
Raised if <parameter>name</parameter> is not an attribute of this element.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.dom-domdocument-getelementbyid" /></member>
<member><xref linkend="function.dom-domelement-setidattribute" /></member>
<member><xref linkend="function.dom-domelement-setidattributenode" /></member>
</simplelist>
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,23 +1,45 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.dom-domnode-isdefaultnamespace">
<refnamediv>
<refname>DOMNode::isDefaultNamespace</refname>
<refname>DOMNode->isDefaultNamespace()</refname>
<refpurpose>Checks if the specified namespaceURI is the default namespace or not</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>DOMNode::isDefaultNamespace</methodname>
<methodparam><type>string</type><parameter>namespaceURI</parameter></methodparam>
</methodsynopsis>
<classsynopsis>
<ooclass><classname>DOMNode</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>isDefaultNamespace</methodname>
<methodparam><type>string</type><parameter>namespaceURI</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
<ulink url="&url.dom3.spec;#core-Node3-isDefaultNamespace">Specification</ulink>
Tells whether <parameter>namespaceURI</parameter> is the default namespace.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>namespaceURI</parameter></term>
<listitem>
<para>
The namespace URI to look for.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Return &true; if <parameter>namespaceURI</parameter> is the default
namespace, &false; otherwise.
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.23 $ -->
<!-- $Revision: 1.24 $ -->
<!-- Purpose: xml -->
<!-- Membership: bundled, external -->
@ -588,6 +588,15 @@
<listitem>
<para><xref linkend='function.dom-domelement-setattributens' /> - Adds new attribute</para>
</listitem>
<listitem>
<para><xref linkend='function.dom-domelement-setidattribute' /> - Declares the ID attribute</para>
</listitem>
<listitem>
<para><xref linkend='function.dom-domelement-setidattributenode' /> - Declares the ID attribute</para>
</listitem>
<listitem>
<para><xref linkend='function.dom-domelement-setidattributens' /> - Declares the ID attribute</para>
</listitem>
</itemizedlist>
</section>
<section id='dom.class.domelement.properties'>
@ -857,6 +866,10 @@
<para><xref linkend='function.dom-domnode-insertbefore' /> - Adds a
new child before a reference node</para>
</listitem>
<listitem>
<para><xref linkend='function.dom-domnode-isdefaultnamespace' /> - Checks if the specified namespaceURI is
the default namespace</para>
</listitem>
<listitem>
<para><xref linkend='function.dom-domnode-issamenode' /> - Indicates if two nodes are the same node</para>
</listitem>