<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: 70ac605e66b5ce0c03a345df92297f3e03f088ca Maintainer: shimooka Status: ready -->

<refentry xml:id="function.iterator-count" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>iterator_count</refname>

<refpurpose>イテレータにある要素をカウントする</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>int</type><methodname>iterator_count</methodname>

<methodparam><type class="union"><type>Traversable</type><type>array</type></type><parameter>iterator</parameter></methodparam>

</methodsynopsis>

<para>

イテレータにある要素をカウントします。

<function>iterator_count</function> は、

<parameter>iterator</parameter> の現在位置がそのまま保たれることを保障しません。

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>iterator</parameter></term>

<listitem>

<para>

カウントしたいイテレータ。

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

<parameter>iterator</parameter> の要素数を返します。

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.2.0</entry>

<entry>

<parameter>iterator</parameter> の型が

<type>Traversable</type> から、

<type class="union"><type>Traversable</type><type>array</type></type>

に拡大されました。

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><function>iterator_count</function> の例</title>

<programlisting role="php">

<![CDATA[

<?php

$iterator = new ArrayIterator(array('recipe'=>'pancakes', 'egg', 'milk', 'flour'));

var_dump(iterator_count($iterator));

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

int(4)

]]>

</screen>

</example>

<example>

<title><function>iterator_count</function> で位置を変更する例</title>

<programlisting role="php">

<![CDATA[

<?php

$iterator = new ArrayIterator(['one', 'two', 'three']);

var_dump($iterator->current());

var_dump(iterator_count($iterator));

var_dump($iterator->current());

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

string(3) "one"

int(3)

NULL

]]>

</screen>

</example>

<example>

<title>&foreach; ループ内での <function>iterator_count</function></title>

<programlisting role="php">

<![CDATA[

<?php

$iterator = new ArrayIterator(['one', 'two', 'three']);

foreach ($iterator as $key => $value) {

echo "$key: $value (", iterator_count($iterator), ")\n";

}?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

0: one (3)

]]>

</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:"~/.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

-->