AppendIterator::key
PHP function
Edit on GitHub ✎
(PHP 5 >= 5.1.0, PHP 7, PHP 8)
Gets the current key
Description
AppendIterator::key(): scalar
Get the current key.
Parameters Parameters
Return Values
The current key if it is valid or null otherwise.
Examples
AppendIterator::key basic example
php
<?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);
// Manual iteration
$iterator->rewind();
while ($iterator->valid()) {
echo $iterator->key() . ' ' . $iterator->current() . PHP_EOL;
$iterator->next();
}
echo PHP_EOL;
// With foreach
foreach ($iterator as $key => $current) {
echo $key . ' ' . $current . PHP_EOL;
}
?>The above example will output:
output
a aardwolf
b bear
c capybara
0 apple
1 orange
2 lemon
a aardwolf
b bear
c capybara
0 apple
1 orange
2 lemonSee Also
Iterator::keyAppendIterator::currentAppendIterator::validAppendIterator::nextAppendIterator::rewind