SplObjectStorage::key

Returns the index at which the iterator currently is

&reftitle.description; public `int` `SplObjectStorage::key`

Returns the index at which the iterator currently is.

&reftitle.parameters; &no.function.parameters;
&reftitle.returnvalues;

The index corresponding to the position of the iterator.

&reftitle.examples;

### `SplObjectStorage::key` example

    <?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();
    }
    ?>

&example.outputs.similar;

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

&reftitle.seealso;

- `SplObjectStorage::rewind`
- `SplObjectStorage::current`
- `SplObjectStorage::next`
- `SplObjectStorage::valid`