AppendIterator::getIteratorIndex

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

AppendIterator::getIteratorIndex — イテレータのインデックスを取得する

説明

public function AppendIterator::getIteratorIndex(): ?int

現在の内部イテレータのインデックスを取得します。

パラメータ

この関数にはパラメータはありません。

戻り値

存在していれば、現在の内部イテレータのインデックス (最初はゼロ) を整数値で返します。存在しない場合、null を返します。

例

例1 AppendIterator.getIteratorIndex() の基本的な例

<?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;
}
?>

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

0  a aardwolf
0  b bear
0  c capybara
1  0 apple
1  1 orange
1  2 lemon

参考

AppendIterator::getInnerIterator()
AppendIterator::getArrayIterator() - ArrayIterator を取得する

関連キーワード:

AppendIterator イテレータインデックス getIteratorIndex iterator ArrayIterator getArrayIterator 内部 aardwolf bear capybara apple orange lemon append current 最初整数基本的 foreach 参考 getInnerIterator