steinm Mon Apr 22 08:05:41 2002 EDT
Modified files:
/phpdoc/en/reference/domxml/functions
DomDocument-get-element-by-id.xml
Log:
- initial documentation and note about different behaviour in contrast to DOM
Index: phpdoc/en/reference/domxml/functions/DomDocument-get-element-by-id.xml
diff -u phpdoc/en/reference/domxml/functions/DomDocument-get-element-by-id.xml:1.2
phpdoc/en/reference/domxml/functions/DomDocument-get-element-by-id.xml:1.3
--- phpdoc/en/reference/domxml/functions/DomDocument-get-element-by-id.xml:1.2 Wed
Apr 17 02:37:37 2002
+++ phpdoc/en/reference/domxml/functions/DomDocument-get-element-by-id.xml Mon
+Apr 22 08:05:41 2002
@@ -1,10 +1,11 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/domxml.xml, last change in rev 1.38 -->
<refentry id="function.DomDocument-get-element-by-id">
<refnamediv>
<refname>DomDocument->get_element_by_id</refname>
<refpurpose>
+ Searches for an element with a certain id
</refpurpose>
</refnamediv>
<refsect1>
@@ -14,9 +15,17 @@
<methodparam><type>string</type><parameter>id</parameter></methodparam>
</methodsynopsis>
<para>
+ This function is similar to
+ <function>DomDocument_get_elements_by_tagname</function> but searches for
+ an element with a given id. According to the DOM standard this requires a
+ DTD which defines the attribute ID to be of type ID, though the current
+ implementation simply does an xpath search for "//*[@ID = '%s']". This
+ does not comply to the DOM standard which requires to return null if it
+ is not known which attribute is of type id. This behaviour is likely to
+ be fixed, so do not rely on the current behaviour.
</para>
<para>
- See also <function>DomDocument_add_root</function>
+ See also <function>DomDocument_get_elements_by_tagname</function>
</para>
</refsect1>
</refentry>
