php-doc-en/reference/dom/functions/dom-domnodelist-item.xml
2004-12-27 16:53:36 +00:00

135 lines
2.8 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry id='function.dom-domnodelist-item'>
<refnamediv>
<refname>DOMNodelist->item()</refname>
<refpurpose>
Retrieves a node specified by index
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMNodeList</classname></ooclass>
<methodsynopsis>
<type>DOMNode</type>
<methodname>item</methodname>
<methodparam><type>int</type><parameter>index</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Retrieves a node specified by <parameter>index</parameter> within the
<classname>DOMNodeList</classname> object.
</para>
<tip>
<para>
If you need to know the number of nodes in the collection, use
the <literal>length</literal> property of the
<classname>DOMNodeList</classname> object.
</para>
</tip>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>index</parameter></term>
<listitem>
<para>
Index of the node into the collection.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The node at the <parameter>index</parameter>th position in the
<classname>DOMNodeList</classname>, or &null; if that is not a valid
index.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Traversing all the entries of the table</title>
<programlisting role="php">
<![CDATA[
<?php
$doc = new DOMDocument;
$doc->load('book.xml');
$items = $doc->getElementsByTagName('entry');
for ($i = 0; $i < $items->length; $i++) {
echo $items->item($i)->nodeValue . "\n";
}
?>
]]>
</programlisting>
<para>
Alternatively, you can use foreach, which is a much more convenient way:
</para>
<programlisting role="php">
<![CDATA[
<?php
foreach ($items as $item) {
echo $item->nodeValue . "\n";
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Title
Author
Language
ISBN
The Grapes of Wrath
John Steinbeck
en
0140186409
The Pearl
John Steinbeck
en
014017737X
Samarcande
Amine Maalouf
fr
2253051209
]]>
</screen>
</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
-->