iterator_count

    (PHP 5 >= 5.1.0, PHP 7, PHP 8)

    iterator_count — イテレータにある要素をカウントする

    説明

    iterator_count(Traversable|array $iterator): int

    イテレータにある要素をカウントします。 iterator_count() は、 iterator の現在位置がそのまま保たれることを保障しません。

    パラメータ

    iterator

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

    戻り値

    iterator の要素数を返します。

    変更履歴

    バージョン 説明
    8.2.0 iterator の型が Traversable から、 Traversable|array に拡大されました。

    例

    例1 iterator_count() の例

    <?php
    $iterator     = new ArrayIterator(array('recipe'=>'pancakes', 'egg', 'milk', 'flour'));
    var_dump(iterator_count($iterator));
    ?>

    上の例の出力は以下となります。

    int(4)

    例2 iterator_count() で位置を変更する例

    <?php
    $iterator     = new ArrayIterator(['one', 'two', 'three']);
    var_dump($iterator->current());
    var_dump(iterator_count($iterator));
    var_dump($iterator->current());
    ?>

    上の例の出力は以下となります。

    string(3) "one"
int(3)
NULL

    例3 foreach ループ内での iterator_count()

    <?php
    $iterator     = new ArrayIterator(['one', 'two', 'three']);
    foreach (    $iterator as $key => $value) {
    echo     "$key: $value (", iterator_count($iterator), ")\n";
    }    ?>

    上の例の出力は以下となります。

    0: one (3)

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 2 notes

    up
    3
    oleksii dot bulba at gmail dot com
    3 years ago
    Be aware that counting over NoRewindIterator will make items unavailable:

    <?php

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

    var_dump($iterator->current());
    var_dump(iterator_count($iterator));
    var_dump($iterator->current());
    $iterator->rewind(); // Does not work because it's NoRewindIterator
    var_dump($iterator->current());
    var_dump(iterator_count($iterator));

    ?>

    Output:

    <?php

    /*
    string(8) "pancakes"
    int(4)
    NULL
    NULL
    */
    int(0)

    ?>
    up
    2
    info at ensostudio dot ru
    4 years ago
    Safe using:
    <?php
    $cnt     = iterator_count(clone $iterator);
    ?>
    ＋add a note
    To Top