php / 8.1.5 / splobjectstorage.current.html /

SplObjectStorage::current

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

SplObjectStorage::currentReturns the current storage entry

Description

public SplObjectStorage::current(): object

Returns the current storage entry.

Parameters

This function has no parameters.

Return Values

The object at the current iterator position.

Changelog

Version Description
8.1.0 SplObjectStorage::current() now throws an Error exception if the current position is invalid. Previously, false was returned instead.

Examples

Example #1 SplObjectStorage::current() 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)
    $data   = $s->getInfo();

    var_dump($object);
    var_dump($data);
    $s->next();
}
?>

The above example will output something similar to:

object(stdClass)#2 (0) {
}
string(2) "d1"
object(stdClass)#3 (0) {
}
string(2) "d2"

See Also

© 1997–2021 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/splobjectstorage.current.php