MultipleIterator::key
アタッチされているイテレータのキーを取得する
説明
public array MultipleIterator::key()
有効なイテレータそれぞれの Iterator::key
をコールし、アタッチされているすべてのイテレータの現在のキーを取得します。
MultipleIterator::MIT_KEYS_NUMERIC の場合、
各イテレータのキーはアタッチした順に並びます。
MultipleIterator::MIT_KEYS_ASSOC の場合、
MultipleIterator::attachIterator
で各イテレータに関連づけた情報が、返される配列のキーになります。
戻り値
アタッチされている各イテレータの現在のキーを含む配列を返します。
MultipleIterator::MIT_NEED_ANY の場合、
無効なイテレータのキーは null になります。
エラー / 例外
アタッチされているイテレータがない場合、または
MultipleIterator::MIT_NEED_ALL が設定されていて、
無効なイテレータがひとつでもある場合、
RuntimeException をスローします。
MultipleIterator::MIT_KEYS_ASSOC が設定されていて、
情報を関連づけずアタッチされたイテレータがある場合、
InvalidArgumentException をスローします。
例
例1 MultipleIterator::key の例
<?php
$iterator = new MultipleIterator(MultipleIterator::MIT_NEED_ANY | MultipleIterator::MIT_KEYS_ASSOC);
$iterator->attachIterator(new ArrayIterator(['a' => 'apple', 'b' => 'banana']), 'fruit');
$iterator->attachIterator(new ArrayIterator(['x' => 'red']), 'color');
$iterator->rewind();
while ($iterator->valid()) {
var_dump($iterator->key());
$iterator->next();
}
?>
array(2) {
["fruit"]=>
string(1) "a"
["color"]=>
string(1) "x"
}
array(2) {
["fruit"]=>
string(1) "b"
["color"]=>
NULL
}
参考
- MultipleIterator::current
- MultipleIterator::valid