What happens if the same object instance is attached multiple times to SplObjectStorage?

Question

Or in other words, should I bother checking whether it already is in the set before attaching it?

$s = new SplObjectStorage();

foreach($arrayOfObjects as $primaryObject) {
    $subObject=$primaryObject->getSubObject();  //It is possible that a given instance of $subObject might be used in more than one $primaryObject
    if(!$s->contains($subObject)) {
        $s->attach($subObject);
    }
}

score 4 · Accepted Answer · answered Aug 21 '18 at 16:34

The "key" used internally by SplObjectStorage for each attached object is the hash of the given object (the same as returned by spl_object_hash).

Each call to attach will effectively overwrite any existing object in the storage with the same hash (which should only happen if you're providing the same object), so there's no need to call contains before attaching an object.

SplObjectStorage::attach($object) effectively means the same as

$storage[spl_object_hash($object)] = $object;

if you were using an array as your store instead.

Full demo:

class Foo {}
$foo = new Foo;
$s = new SplObjectStorage;

echo $s->count(); // 0

$s->attach($foo);
echo $s->count(); // 1

$s->attach($foo);
echo $s->count(); // 1

$s->detach($foo);
echo $s->count(); // 0

See https://3v4l.org/Rft7i

Thanks, I thought so, but couldn't find any documentation. – user1032531 Aug 21 '18 at 16:43 — user1032531, Aug 21 '18 at 16:43
Yeah, the SPL documentation is... patchy – iainn Aug 21 '18 at 16:44 — iainn, Aug 21 '18 at 16:44

What happens if the same object instance is attached multiple times to SplObjectStorage?

1 Answers1