php-doc-en/reference/dom/domelement/setidattributenode.xml
2013-06-18 05:36:30 +00:00

108 lines
2.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="domelement.setidattributenode" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>DOMElement::setIdAttributeNode</refname>
<refpurpose>Declares the attribute specified by node to be of type ID</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>DOMElement::setIdAttributeNode</methodname>
<methodparam><type>DOMAttr</type><parameter>attr</parameter></methodparam>
<methodparam><type>bool</type><parameter>isId</parameter></methodparam>
</methodsynopsis>
<para>
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><methodname>DOMDocument::getElementById</methodname></member>
<member><methodname>DOMElement::setIdAttribute</methodname></member>
<member><methodname>DOMElement::setIdAttributeNS</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
-->