SplObjectStorage::key
PHP function
Edit on GitHub ✎
(PHP 5 >= 5.1.0, PHP 7, PHP 8)
Returns the index at which the iterator currently is
Description
SplObjectStorage::key(): int
Returns the index at which the iterator currently is.
Parameters Parameters
Return Values
The index corresponding to the position of the iterator.
Examples
SplObjectStorage::key() example
php
<?php
$s = new SplObjectStorage();
$o1 = new stdClass;
$o2 = new stdClass;
$s->attach($o1, "d1");
$s->attach($o2, "d2");
$s->rewind();
while($s->valid()) {
$index = $s->key();
$object = $s->current(); // similar to current($s)
var_dump($index);
var_dump($object);
$s->next();
}
?>The above example will output something similar to:
output
int(0)
object(stdClass)#2 (0) {
}
int(1)
object(stdClass)#3 (0) {
}See Also
SplObjectStorage::rewindSplObjectStorage::currentSplObjectStorage::nextSplObjectStorage::valid