mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 06:18:56 +00:00
656d1610af
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@330543 c90b9560-bf6c-de11-be94-00142212c4b1
108 lines
2.9 KiB
XML
108 lines
2.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="domdocument.getelementbyid" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>DOMDocument::getElementById</refname>
|
|
<refpurpose>Searches for an element with a certain id</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>DOMElement</type><methodname>DOMDocument::getElementById</methodname>
|
|
<methodparam><type>string</type><parameter>elementId</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function is similar to
|
|
<xref linkend="domdocument.getelementsbytagname" /> but
|
|
searches for an element with a given id.
|
|
</para>
|
|
<para>
|
|
For this function to work, you will need either to set some ID attributes
|
|
with <xref linkend="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="domdocument.validate" />
|
|
or <link
|
|
linkend="domdocument.props.validateonparse">DOMDocument::$validateOnParse</link> before using this function.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>elementId</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The unique id value for an element.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the <classname>DOMElement</classname> or &null; if the element is
|
|
not found.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title>DOMDocument::getElementById() Example</title>
|
|
&dom.book.example;
|
|
<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 'php-basics' is: " . $doc->getElementById('php-basics')->tagName . "\n";
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
The element whose id is 'php-basics' is: book
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><methodname>DOMDocument::getElementsByTagName</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
|
|
-->
|