php8.5
Home/ Manual/ spl / splobjectstorage/ SplObjectStorage::offsetGet

SplObjectStorage::offsetGet

PHP function Edit on GitHub ✎

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

Returns the data associated with an object

Description

SplObjectStorage::offsetGet(object $object): mixed

Returns the data associated with an object in the storage.

Parameters

object

The object to look for.

Return Values

The data previously associated with the object in the storage.

Errors/Exceptions

Throws UnexpectedValueException when object could not be found.

Examples

SplObjectStorage::offsetGet() example

php
<?php
$s = new SplObjectStorage;

$o1 = new stdClass;
$o2 = new stdClass;

$s[$o1] = "hello";
$s->attach($o2);


var_dump($s->offsetGet($o1)); // Similar to $s[$o1]
var_dump($s->offsetGet($o2)); // Similar to $s[$o2]
?>

The above example will output something similar to:

output
string(5) "hello"
NULL

See Also

  • SplObjectStorage::offsetSet
  • SplObjectStorage::offsetExists
  • SplObjectStorage::offsetUnset

Source: reference/spl/splobjectstorage/offsetget.xml · from the official PHP manual (php/doc-en)