MultipleIterator combines values from multiple iterators at matching iteration positions.
What Is MultipleIterator::key in PHP?
Reads the current key or generated position identifier.
MultipleIterator::key()This operation does not accept method arguments.
Example 1: Understanding the Basic Behavior
<?php
$iterator = new MultipleIterator(MultipleIterator::MIT_NEED_ANY);
$firstIterator = new ArrayIterator([1, 2]);
$secondIterator = new ArrayIterator(['a', 'b']);
$iterator->attachIterator($firstIterator, "numbers");
$iterator->attachIterator($secondIterator, "letters");
$iterator->rewind();
var_dump($iterator->key());Output:
array(2) {
[0]=>
int(0)
[1]=>
int(0)
}Explanation: Reads the current key or generated position identifier.
Example 2: Testing Another Case
<?php
$iterator = new MultipleIterator(MultipleIterator::MIT_NEED_ANY);
$firstIterator = new ArrayIterator([5, 6]);
$secondIterator = new ArrayIterator(['c', 'd']);
$iterator->attachIterator($firstIterator, "numbers");
$iterator->attachIterator($secondIterator, "letters");
$iterator->rewind();
var_dump($iterator->key());Output:
array(2) {
[0]=>
int(0)
[1]=>
int(0)
}Explanation: Keys may be strings or integers and can repeat across wrapped iterators.
Practical Example: Applying the Operation
<?php
$iterator = new MultipleIterator(MultipleIterator::MIT_NEED_ANY);
$firstIterator = new ArrayIterator([8, 9]);
$secondIterator = new ArrayIterator(['e', 'f']);
$iterator->attachIterator($firstIterator, "numbers");
$iterator->attachIterator($secondIterator, "letters");
$iterator->rewind();
var_dump($iterator->key());Output:
array(2) {
[0]=>
int(0)
[1]=>
int(0)
}Explanation: The MIT_NEED_ALL and MIT_NEED_ANY options change when iteration stops; keys may be positional or associated.
Important Behavior and Edge Cases
- Keys may be strings or integers and can repeat across wrapped iterators.
- The MIT_NEED_ALL and MIT_NEED_ANY options change when iteration stops; keys may be positional or associated.
Comparison With Related Approaches
| Approach | When to Use It |
|---|---|
MultipleIterator::key | Reads the current key or generated position identifier. |
ArrayIterator | AppendIterator concatenates iterators sequentially; MultipleIterator reads several iterators in parallel. |
Common Beginner Mistakes
| Mistake | Correct Approach |
|---|---|
| Assuming iterator keys are always consecutive integers. | Keys may be strings or integers and can repeat across wrapped iterators. |
| Choosing ArrayIterator without checking whether it provides the same result. | AppendIterator concatenates iterators sequentially; MultipleIterator reads several iterators in parallel. |
Key Takeaways
- Reads the current key or generated position identifier.
- Keys may be strings or integers and can repeat across wrapped iterators.
- The MIT_NEED_ALL and MIT_NEED_ANY options change when iteration stops; keys may be positional or associated.
The examples demonstrate where MultipleIterator::key fits within synchronized iteration. Verify the relevant preconditions whenever you adapt the code to real data.