php-doc-en/reference/dom/functions/dom-domdocument-getelementbyid.xml
2004-12-20 03:10:23 +00:00

78 lines
2.3 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry id="function.dom-domdocument-getelementbyid">
<refnamediv>
<refname>DOMDocument->getElementById</refname>
<refpurpose>Searches for an element with a certain id</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMDocument</classname></ooclass>
<methodsynopsis>
<type>DOMElement</type>
<methodname>getElementById</methodname>
<methodparam><type>string</type><parameter>elementId</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
This function is similar to
<link linkend="function.dom-domdocument-getelementsbytagname">DOMDocument->getElementsByTagName()</link>
but 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
<link linkend="function.dom-domdocument-validate">DOMDocument->validate()</link>
or <literal>DOMDocument::validateOnParse</literal> before using this function.
</para>
<example>
<title>DOMDocument->getElementById() 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');
echo "The element whose id is books is: " . $doc->getElementById('books')->tagName . "\n";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
The element whose id is books is: chapter
]]>
</screen>
</example>
<para>
See also <link linkend="function.dom-domdocument-getelementsbytagname">DOMDocument->getElementsByTagName()</link>.
</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
-->