SplObjectStorage::key

(PHP 5 >= 5.1.0, PHP 7)
Returns the index at which the iterator currently is
public int SplObjectStorage::key ( void )

Returns the index at which the iterator currently is.

Returns:

The index corresponding to the position of the iterator.

Examples:
SplObjectStorage::key() example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<?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:

int(0)
object(stdClass)#2 (0) {
}
int(1)
object(stdClass)#3 (0) {
}
See also:

SplObjectStorage::rewind() -

SplObjectStorage::current() -

SplObjectStorage::next() -

SplObjectStorage::valid() -

doc_php
2025-01-10 15:47:30
Comments
Leave a Comment

Please login to continue.