php-doc-en/reference/dom/functions/dom-domattr-isid.xml
Mehdi Achour 2b1af939e4 Used the new documentation format in the documented functions
Documented, reviewed and added examples to DOMDocument->__construct(), createEle
ment*, load, loadXML, save*.
Also documented DOMDocument->xinclude() and found bug #31200


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@175146 c90b9560-bf6c-de11-be94-00142212c4b1
2004-12-20 15:57:49 +00:00

83 lines
2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry id='function.dom-domattr-isId'>
<refnamediv>
<refname>DOMAttr->isId</refname>
<refpurpose>
Checks if attribute is a defined ID
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMAttr</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>isId</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>
This function checks if the attribute is a defined 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
<link linkend="function.dom-domdocument-validate">DOMDocument->validate()</link>
or <literal>DOMDocument::validateOnParse</literal> before using this function.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>DOMAttr->isId() Example</title>
<programlisting role="php">
<![CDATA[
<?php
$doc = new DomDocument;
// We need to validate our document before refering to the id
$doc->validateOnParse = true;
$doc->Load('book.xml');
// We retrieve the attribute named id of the chapter element
$attr = $doc->getElementsByTagName('chapter')->item(0)->getAttributeNode('id');
var_dump($attr->isId()); // bool(true)
?>
]]>
</programlisting>
</example>
</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
-->