getiteratorindex.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="appenditerator.getiteratorindex" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>AppendIterator::getIteratorIndex</refname>
  <refpurpose>イテレータのインデックスを取得する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="AppendIterator">
   <modifier>public</modifier> <type class="union"><type>int</type><type>null</type></type><methodname>AppendIterator::getIteratorIndex</methodname>
   <void/>
  </methodsynopsis>
  <para>
   現在の内部イテレータのインデックスを取得します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   存在していれば、
   現在の内部イテレータのインデックス (最初はゼロ) を整数値で返します。
   存在しない場合、&null; を返します。
  </para>
 </refsect1>

 <refsect1 role="examples"><!-- {{{ -->
  &reftitle.examples;
  <para>
   <example xml:id="appenditerator.getiteratorindex.examples.basic"><!-- {{{ -->
    <title><methodname>AppendIterator.getIteratorIndex</methodname> の基本的な例</title>
    <programlisting role="php">
<![CDATA[
<?php
$array_a = new ArrayIterator(array('a' => 'aardwolf', 'b' => 'bear', 'c' => 'capybara'));
$array_b = new ArrayIterator(array('apple', 'orange', 'lemon'));

$iterator = new AppendIterator;
$iterator->append($array_a);
$iterator->append($array_b);

foreach ($iterator as $key => $current) {
    echo $iterator->getIteratorIndex() . '  ' . $key . ' ' . $current . PHP_EOL;
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
0  a aardwolf
0  b bear
0  c capybara
1  0 apple
1  1 orange
1  2 lemon

]]>
    </screen>
   </example><!-- }}} -->
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>AppendIterator::getInnerIterator</methodname></member>
    <member><methodname>AppendIterator::getArrayIterator</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
-->